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

dev: updated session for new schema #20

Merged
merged 10 commits into from
Jan 3, 2024
Merged

Conversation

micahwoodard
Copy link
Contributor

closes #19

@micahwoodard micahwoodard marked this pull request as draft December 19, 2023 18:56
@micahwoodard micahwoodard marked this pull request as ready for review December 20, 2023 17:04
Copy link
Contributor

@jtyoung84 jtyoung84 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 for the most part. A couple of small requests:

  1. For the functions with arguments, we try to keep the docstring updated. I think pycharm highlights a warning if the function args don't match the descriptions in the docstrings. We settled on using NumPy's docstring format. There's a way in Pycharm to configure the format and auto-generate a template.

  2. For the unit tests, it's ideal to compare the expected output with the actual output. In both the unit tests, there should be a line like self.assetEqual(expected_output, actual_output). It's not foolproof , but it does give some indication of what should be expected in case someone makes updates to your code down the road.

@micahwoodard micahwoodard requested a review from jtyoung84 January 3, 2024 15:51
@jtyoung84 jtyoung84 merged commit d9e772c into main Jan 3, 2024
2 checks passed
@jtyoung84 jtyoung84 deleted the dev-19-update-ophys-schema branch January 3, 2024 18:28
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.

Mapper that maps ophys metadata files to session.json files
2 participants