Skip to content

Commit b9ace66

Browse files
docs: name the DataJoint Library where the product is named (#1570)
The Python package is the DataJoint Library, distinct from the DataJoint Platform. Naming it by its language or its licence leaves a reader to infer there is an open-source variant of the platform beside the commercial one. Applied where the product is named rather than to every version string: the README title and opening sentence, the PyPI summary, and the release title the drafter generates -- so releases read "DataJoint Library 2.3.5" rather than "Release 2.3.5". Inline version references in docstrings are unchanged. "Deprecated in DataJoint 2.0" is a version, not a product name, and qualifying all 29 of them would add length without adding information. The published 2.3.4 release was retitled by hand; this makes the next one follow without intervention.
1 parent 68fdea5 commit b9ace66

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎.github/workflows/draft_release.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ jobs:
2626
with:
2727
config-name: release_drafter.yaml
2828
disable-autolabeler: true
29-
name: ${{ github.event.inputs.testpypi == 'true' && 'Test $RESOLVED_VERSION' || 'Release $RESOLVED_VERSION' }}
29+
name: ${{ github.event.inputs.testpypi == 'true' && 'Test DataJoint Library $RESOLVED_VERSION' || 'DataJoint Library $RESOLVED_VERSION' }}
3030
env:
3131
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# DataJoint for Python
1+
# DataJoint Library for Python
22

3-
DataJoint is a framework for scientific data pipelines based on the **Relational Workflow Model** — a paradigm where your database schema is an executable specification of your workflow.
3+
The **DataJoint Library** is a framework for scientific data pipelines based on the **Relational Workflow Model** — a paradigm where your database schema is an executable specification of your workflow.
44

55
- **Tables represent workflow steps** — Each table is a step in your pipeline
66
- **Foreign keys encode dependencies** — Parent tables must be populated before child tables

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ maintainers = [
3232
{name = "DataJoint Contributors", email = "support@datajoint.com"},
3333
]
3434
# manually sync here: https://docs.datajoint.com/core/datajoint-python/latest/#welcome-to-datajoint-for-python
35-
description = "DataJoint for Python is a framework for scientific workflow management based on relational principles. DataJoint is built on the foundation of the relational data model and prescribes a consistent method for organizing, populating, computing, and querying data."
35+
description = "The DataJoint Library for Python is a framework for scientific workflow management based on relational principles. It is built on the foundation of the relational data model and prescribes a consistent method for organizing, populating, computing, and querying data."
3636
readme = "README.md"
3737
license = {file = "LICENSE"}
3838
keywords = [

0 commit comments

Comments
 (0)