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

Minor cleanup/documentation cleanup of schema and models #887

Merged
merged 4 commits into from
Mar 21, 2024

Conversation

IanCa
Copy link
Member

@IanCa IanCa commented Mar 20, 2024

No description provided.

@IanCa
Copy link
Member Author

IanCa commented Mar 20, 2024

spec_tests failure is expected, pending PR approval on hed-specification

Returns:
list: A list of issues. Each issue is a dictionary.
"""
"""Check if the single tag is a partnered schema tag"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the documentation of the Parameters and Returns being removed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because it was the exact same on all of those functions, there's a template at the top of the file(I just fixed a mistake in it). Users would never be calling these functions directly.

I'm happy to add the parameter/return value doc strings back if desired, they just didn't seem helpful to me.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put them back in. When you jump to a particular function from a link in the docs you don't see the template.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Member

@VisLab VisLab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly looks good -- but the documentation of Parameters and Returns were removed in a number of places --- I didn't think this documentation should be removed.

@IanCa
Copy link
Member Author

IanCa commented Mar 20, 2024

I went ahead and added disabling owl related code to this PR

@VisLab VisLab merged commit 05e80c0 into hed-standard:develop Mar 21, 2024
7 of 9 checks passed
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

Successfully merging this pull request may close these issues.

2 participants