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

Improve docs #37

Open
jcreinhold opened this issue Sep 3, 2021 · 3 comments
Open

Improve docs #37

jcreinhold opened this issue Sep 3, 2021 · 3 comments
Assignees
@jcreinhold
Labels
documentation Something is wrong with the documentation

Comments

@jcreinhold
Copy link
Owner

jcreinhold commented Sep 3, 2021 •
edited
Loading

📚 Documentation

While the refactor improved code quality and reduced the need for some documentation, additional documentation needs to be added, perhaps with examples (that always run), via docstrings to the user-facing functions.

See doctest and the pytest extension.
@jcreinhold jcreinhold added the enhancement New feature or request label Sep 3, 2021
@jcreinhold jcreinhold self-assigned this Sep 3, 2021
@jcreinhold jcreinhold mentioned this issue Oct 11, 2021
Closed
@jcreinhold jcreinhold added documentation Something is wrong with the documentation and removed enhancement New feature or request labels Jan 25, 2022
@jcreinhold
Copy link
Owner Author

jcreinhold commented Feb 26, 2022 •
edited
Loading

Add algorithm description for least-squares normalization.

@jcreinhold
Copy link
Owner Author

Add example using DICOM and other formats

@jcreinhold
Copy link
Owner Author

  • Quantile matching description of Nyul method.
  • Fix location of docstrings
  • Fix tutorials

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jcreinhold jcreinhold

Labels
documentation Something is wrong with the documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jcreinhold