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

schemacode: Improve API documentation for the schema object #2024

Open
effigies opened this issue Jan 6, 2025 · 0 comments
Open

schemacode: Improve API documentation for the schema object #2024

effigies opened this issue Jan 6, 2025 · 0 comments
Labels
documentation schema-code Updates or changes to the code used to parse, filter, and render the schema.

Comments

@effigies
Copy link
Collaborator

effigies commented Jan 6, 2025 •
edited
Loading

Docs for the Namespace class show the use of .items/keys/values(level=2).

https://bidsschematools.readthedocs.io/en/latest/api/bidsschematools.types.namespace.html#bidsschematools.types.namespace.Namespace

It looks like we don't make it clear that that's what you're getting from load_schema.

Originally posted by @effigies in bids-standard/python-validator#12 (comment)
@effigies effigies added documentation schema-code Updates or changes to the code used to parse, filter, and render the schema. labels Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation schema-code Updates or changes to the code used to parse, filter, and render the schema.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@effigies