AllenNeuralDynamics / AllenNeuralDynamics/biodata-schema

Consider aligning the name of scoped properties

未关闭
#46 3 条评论 0 个 reaction 已指派 1 人 已被 @dbirman 认领 在 GitHub 查看
主要语言
Python
星标
0
派生
0
PR 合并指标
30 天内没有已合并 PR

描述

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

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。