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

Add/edit cubids.py docstrings #411

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Add/edit cubids.py docstrings #411

wants to merge 16 commits into from

Conversation

singlesp
Copy link
Contributor

@singlesp singlesp commented Jan 17, 2025

Closes #358 and closes #384.

Changes proposed in this pull request

  • add/edit docstrings to cubids.py

@singlesp singlesp marked this pull request as draft January 17, 2025 20:56
@tsalo tsalo added the documentation Improvements or additions to documentation label Jan 21, 2025
@tsalo tsalo changed the title add/edit cubids.py docstrings Add/edit cubids.py docstrings Jan 21, 2025
@singlesp singlesp marked this pull request as ready for review January 21, 2025 16:31
@singlesp
Copy link
Contributor Author

fixed docstrings on entity key but that broke build path doctests and a bunch of other stuff from there. Need to update and revert back to ba31cca and delete doctests in get_entity_value and img_to_new_ext

@singlesp
Copy link
Contributor Author

singlesp commented Jan 24, 2025

orig doc test was failing due to path/to file in the doctest not containing the ses and sub folders. That means this function as written previously will only work for ses and sub.

try using this for get entity value:

from bids.layout import parse_file_entities

@singlesp singlesp force-pushed the cubids.py-docstrings branch from 18707d3 to 03c5491 Compare January 24, 2025 20:26
@singlesp
Copy link
Contributor Author

after trying to make get_entity_values more generalizable, I ultimately came to the conclusion that this function was indeed written for this very specific scenario.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

edit the files in cubids dir Complete docstrings for all functions and classes in CuBIDS
3 participants