Dataset structure schema - [merged] #50

Closed lewisjared closed 3 weeks ago

In GitLab by @yinilaii on Dec 6, 2023, 09:31

_Merges dataset_structureschema -> main

Pull request

Please confirm that this pull request has done the following:

[ ] Tests added
[ ] Documentation added (where applicable)
[ ] Example added (either to an existing notebook or as a new notebook, where applicable)
[ ] Changelog entry added to /changelog
[ ] Book has been published and verified with the CI (where applicable)

In GitLab by @yinilaii on Dec 6, 2023, 09:31

requested review from @yinilaii and @lewisjared

In GitLab by @yinilaii on Dec 7, 2023, 14:31

added 1 commit

In GitLab by @yinilaii on Dec 7, 2023, 15:16

added 1 commit

These all need docstrings. Particularly the type one. It should list the valid types that can be specified

    name: str
    """
    Name of the metadata dimensions
    """"

docstrings for the items. I don't think I did it previously, but we should start

class ControlledVocabulary(BaseModel):

Can you add a test without the CV field?

Did you mean to add this?

    An item in a controlled vocabulary for the a given dimensions

Should we call it a data dictionary? I think that term would resonate best. Also docstring

    data_dictionary: list[Dimension]

    Dimension information

    A dimension describes a feature of the metadata (expressed as a column in the index of an {py:class}`scmdata.ScmRun`).