Skip to content

Commit 58069c8

Browse files
authored
docs: clarify DataDescription.name, re-build all docs (without API) (#1691)
1 parent e172cb0 commit 58069c8

8 files changed

Lines changed: 6 additions & 323 deletions

File tree

.github/workflows/update_docs.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,6 @@ jobs:
6262
run: |
6363
sudo apt install graphviz libgraphviz-dev -y
6464
python -m pip install -e .[dev] -e .[docs] --no-cache-dir
65-
- name: Generate new rst files
66-
run: |
67-
sphinx-apidoc -o docs/source/ src
6865
- name: Commit changes
6966
uses: EndBug/add-and-commit@v9
7067
with:

docs/source/aind_data_schema.components.rst

Lines changed: 0 additions & 125 deletions
This file was deleted.

docs/source/aind_data_schema.core.rst

Lines changed: 0 additions & 85 deletions
This file was deleted.

docs/source/aind_data_schema.rst

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/source/aind_data_schema.utils.rst

Lines changed: 0 additions & 69 deletions
This file was deleted.

docs/source/data_description.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Description of a logical collection of data files
2727
| `subject_id` | `Optional[str]` | Subject ID (Unique identifier for the subject of data acquisition) |
2828
| `creation_time` | `datetime (timezone-aware)` | Creation Time (Time that data files were created, used to uniquely identify the data) |
2929
| `tags` | `Optional[List[str]]` | Tags (Descriptive strings to help categorize and search for data) |
30-
| `name` | `Optional[str]` | Name (Name of data, conventionally also the name of the directory containing all data and metadata) |
30+
| `name` | `Optional[str]` | Data asset name (When left blank, a name will be generated based on subject_id and creation_time. Conventionally also used as the name of the data folder.) |
3131
| `institution` | [Organization](aind_data_schema_models/organizations.md#organization) | Institution (An established society, corporation, foundation or other organization that collected this data) |
3232
| `funding_source` | List[[Funding](data_description.md#funding)] | Funding source (Funding source. If internal funding, select 'Allen Institute') |
3333
| `data_level` | [DataLevel](aind_data_schema_models/data_name_patterns.md#datalevel) | Data Level (Level of processing that data has undergone) |

docs/source/modules.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

src/aind_data_schema/core/data_description.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,11 @@ class DataDescription(DataCoreModel):
5858
)
5959
name: Optional[str] = Field(
6060
default=None,
61-
description="Name of data, conventionally also the name of the directory containing all data and metadata",
62-
title="Name",
61+
description=(
62+
"When left blank, a name will be generated based on subject_id and creation_time. "
63+
"Conventionally also used as the name of the data folder."
64+
),
65+
title="Data asset name",
6366
validate_default=True,
6467
)
6568
institution: Organization.RESEARCH_INSTITUTIONS = Field(

0 commit comments

Comments
 (0)