Update the documentation with ALLOW_DUPLICATE_FIELD #72
Merged
Conversation
Add the documentation of the feature ALLOW_DUPLICATE_FIELD, which enables the reading of NRRD files with duplicated header fields.
Add the documentation of the feature ALLOW_DUPLICATE_FIELD, which enables the reading of NRRD files with duplicated header fields.
Add the documentation of the feature ALLOW_DUPLICATE_FIELD, which enables the reading of NRRD files with duplicated header fields.
Codecov Report
@@ Coverage Diff @@
## master #72 +/- ##
=======================================
Coverage 87.39% 87.39%
=======================================
Files 6 6
Lines 357 357
Branches 114 114
=======================================
Hits 312 312
Misses 22 22
Partials 23 23
Continue to review full report at Codecov.
|
Great work! For documentation, the only way for me to 'test' that it is okay is by retrieving the PR and compiling it by hand. Since I'm that far, I decided to make some changes of my own and commit them. For the most part, small wording and grammar changes were made. Also updated the API reference to show the ALLOW_DUPLICATE_FIELD docstring in addition to it being displayed in the table of contents for the reading section. Update references to True/False & ALLOW_DUPLICATE_FIELD so Sphinx appropriately links to these items. Also found a small mistake in the tests that was missed originally I decided to fix here. Wasn't worth the extra effort of a separate PR.
Collaborator
|
I mentioned some of this in my commit, but I pushed some changes to your branch (hope that's okay). I had to get your changes to compile them and check out the docs, so I figured I might as well change the documentation while I had it. Once I get your approval on this, I will merge it. |
Contributor
Author
|
Those are perfect, thank you very much @addisonElliott |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation update to include the ALLOW_DUPLICATE_FIELD information (#71 )
I am not used to Sphinx, but I update it using the sphinx-doc by hand.
http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html
I hope it is close to the expected.