DOC: Update docs following read-through #2930
Merged
Conversation
This file contains 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
mgxd
approved these changes
Jan 26, 2023
Normalized to sentence casing (was haphazard).
Removed some string breaks ("x" " y" -> "x y").
Updated some language for clearer reading in usage.html
Improve the documentation for some wrapper args
Update example figures, clarify BBR workflows, and use BIDS layout to describe FreeSurfer processing. DOC: Dedent lists to avoid block quoting
|
@mgxd Rebased rather than amend the merge commit. Full diff incorporating your suggestions: https://github.com/nipreps/fmriprep/compare/5bf536c5cc1d96bf391080228ebec6ee97c95b79..54410e8fda975fb3895e9ea2a0469b8cf68c921c |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes proposed in this pull request
This PR goes through all of the documentation except for the API docs. I have made sure that all workflow graphs are generated, but not that the docstrings match the function signatures. I did add type annotations to the
init_*_wf()functions to improve that, at least.This is pretty wide-ranging and addresses all warnings from Sphinx.
This does not change the theme, as the sphinx-immaterial theme I was considering made the API page unusable. That should be done more thoughtfully in a separate PR.
Documentation that should be reviewed
All of it.