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

Clean documentation and readme #80

Merged
merged 3 commits into from
Jan 10, 2021
Merged

Clean documentation and readme #80

merged 3 commits into from
Jan 10, 2021

Conversation

Enet4
Copy link
Owner

@Enet4 Enet4 commented Jan 9, 2021

  • Clean up documentation blocks
    • escape square brackets when they are not supposed to be links
    • code formatting for certain identifiers and mathematical expressions
    • fix an intra-link in the streamed module
  • Update readme to use ReaderOptions instead of deprecated functions.
    This is pretty much the reason why I stick to very short examples in the readme file, if any.

Enet4 added 3 commits January 9, 2021 15:12
- escape square brackets when they do not mean links
- use code formatting for
  identifiers and mathematical expressions
- fix intra-link case in StreamedNiftiVolume
@nilgoyette
Copy link
Collaborator

cargo doc runs without problem on all features. +1

@Enet4 Enet4 merged commit 7fd4143 into master Jan 10, 2021
@Enet4 Enet4 deleted the imp/docs-update branch January 10, 2021 17:48
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