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

[ENH] Some missing docstrings for bidsschematools #1413

Merged
merged 4 commits into from
Feb 17, 2023

Conversation

anibalsolon
Copy link
Contributor

Adding some more docstrings for the bidsschematools.

@codecov
Copy link

codecov bot commented Feb 10, 2023

Codecov Report

Base: 88.65% // Head: 88.88% // Increases project coverage by +0.23% 🎉

Coverage data is based on head (8eed135) compared to base (134f532).
Patch has no changes to coverable lines.

❗ Current head 8eed135 differs from pull request most recent head a7e7058. Consider uploading reports for the commit a7e7058 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1413      +/-   ##
==========================================
+ Coverage   88.65%   88.88%   +0.23%     
==========================================
  Files          11       11              
  Lines        1084     1080       -4     
==========================================
- Hits          961      960       -1     
+ Misses        123      120       -3     
Impacted Files Coverage Δ
tools/schemacode/bidsschematools/render/tables.py 87.11% <ø> (ø)
tools/schemacode/bidsschematools/render/text.py 97.47% <ø> (ø)
tools/schemacode/bidsschematools/render/utils.py 85.18% <ø> (ø)
tools/schemacode/bidsschematools/schema.py 77.90% <ø> (+2.35%) ⬆️
...ools/schemacode/bidsschematools/types/namespace.py 91.09% <ø> (ø)
tools/schemacode/bidsschematools/validator.py 96.24% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Collaborator

@bendhouseart bendhouseart left a comment

Choose a reason for hiding this comment

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

Looks good, approval and merge should push to rtd's.

@anibalsolon
Copy link
Contributor Author

hey @TheChymera tagging you here as well, if you'd like to take a look!

@@ -514,7 +514,7 @@ def select_schema_dir(
according to the respective schema version, e.g. "1.7.0".
If the path starts with the string "{module_path}" it will be expanded relative to the
module path.
schema_version : str or None
schema_version : str | None
Copy link
Collaborator

Choose a reason for hiding this comment

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

Above you went in the other direction.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah missed this one- it should be an or. From what I saw from numpydoc that's what's used

Copy link
Collaborator

@effigies effigies left a comment

Choose a reason for hiding this comment

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

Mostly good. We should pick a convention for describing types and stick with it, though.

@effigies effigies merged commit 4549158 into bids-standard:master Feb 17, 2023
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.

3 participants