AllenNeuralDynamics / AllenNeuralDynamics/biodata-schema

Consider aligning the name of scoped properties

Open
#46 3 comments 0 reactions 1 assignee Claimed by @dbirman View on GitHub
Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

In the flavor of what was discussed in https://github.com/AllenNeuralDynamics/aind-data-schema/discussions/856, I was wondering if it would not be easier to onboard users and maintain the library by being consistent with property names being scoped to classes. For instance:

```python
class DataStream(DataModel):
stream_start_time: Annotated[
AwareDatetimeWithDefault,
Field(..., title="Stream start time"),
TimeValidation.BETWEEN,
]
stream_end_time: Annotated[
AwareDatetimeWithDefault,
Field(..., title="Stream stop time"),
TimeValidation.BETWEEN,
]
```

and

```python
class Acquisition(DataCoreModel):
acquisition_start_time: AwareDatetimeWithDefault = Field(..., title="Acquisition start time")
acquisition_end_time: AwareDatetimeWithDefault = Field(..., title="Acquisition end time")
```
represent an identical concept (even if scoped) and yet have different names that are largely just bloat. These could simply be `start_time` and `end_time` respectively

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.