Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for all accepted styles of metadata #230

Open
3 tasks
kkappler opened this issue Oct 7, 2024 · 0 comments
Open
3 tasks

Update docs for all accepted styles of metadata #230

kkappler opened this issue Oct 7, 2024 · 0 comments

Comments

@kkappler
Copy link
Collaborator

kkappler commented Oct 7, 2024

The documentation could be expanded.
This would be particularly helpful if someone wanted to build a UI based on the mt_metadata schema.

Here are some things that could be updated:

  • style could add reference to: name list, number list
  • options only refers to controlled vocabulary (which is like typing.Literal), and seems also relevant to some cases of name list.
  • ACCEPTED_STYLES and REQUIRED_KEYS in the init.py should be described in detail in the docs
    ACCEPTED_STYLES = [
    "name",
    "url",
    "email",
    "number",
    "date",
    "free form",
    "time",
    "date time",
    "name list",
    "number list",
    "controlled vocabulary",
    "alpha numeric",
    ]
    REQUIRED_KEYS = [
    "attribute",
    "type",
    "required",
    "units",
    "style",
    "description",
    "options",
    "alias",
    "example",
    "default",
    ]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant