AllenNeuralDynamics / AllenNeuralDynamics/biodata-schema

Consider aligning the name of scoped properties

Offen
#46 3 Kommentare 0 Reaktionen 1 zugewiesene Person Beansprucht von @dbirman Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
0
Forks
0
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.