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.

Sign up for GitHub

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

Jump to bottom

Provide (interactive) documentation for the meaning of fields in metadata #110

Open
duetosymmetry opened this issue Sep 24, 2024 · 4 comments
Open

Provide (interactive) documentation for the meaning of fields in metadata #110

duetosymmetry opened this issue Sep 24, 2024 · 4 comments
Assignees
@duetosymmetry

Comments

@duetosymmetry
Copy link
Member

No description provided.

@duetosymmetry
Copy link
Member Author

@moble do you have a recommendation for where in the package the field documentation should live?

@duetosymmetry duetosymmetry self-assigned this Oct 2, 2024
@duetosymmetry
Copy link
Member Author

Partially addressed in sxs-collaboration/papers-202X-catalog-update#7, some of that code can be pulled in here once we're happy with it

@moble
Copy link
Member

moble commented Jan 15, 2025

I suppose sxs/sxs/metadata/metadata_fields.py would be the place for it, right?

@duetosymmetry
Copy link
Member Author

I named it metadata_docs.py, but I don't strongly prefer either one. Do you have suggestions about the class structure, and whether to provide a list or dict or both?

Also, we will have to do a bit of archaeology to figure out which fields existed at different versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@duetosymmetry duetosymmetry

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@duetosymmetry @moble