AllenNeuralDynamics / AllenNeuralDynamics/biodata-schema
Consider aligning the name of scoped properties
- Langage dominant
- Python
- Étoiles
- 0
- Forks
- 0
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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
Guide de contribution
Ouvrir le guide de contribution
Évaluation
Cette issue n'a pas encore été évaluée.