Add documentation for flattening and grains #993
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
|
Yay windows again |
SylviaWhittle
requested review from
ns-rse,
MaxGamill-Sheffield and
llwiggins
MaxGamill-Sheffield
requested changes
Nov 9, 2024
There was a problem hiding this comment.
A few clarification suggestions, and notes on figures but really super work with this!
Some are pedantic so if you don't want to do it that's no problem, others however are corrections. I'll throw it on request changes but feel free to "won't fix" + resolve your way through the comments.
Also you might need to re-run the pre-commit hooks if you accept the suggestions via GitHub
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
Co-authored-by: Max Gamill <[email protected]>
|
Added parameter names in flattening docs to guide usage. As this is a docs PR, I've also added things I've seen are missing such as: |
MaxGamill-Sheffield
approved these changes
Nov 13, 2024
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.
Adds documentation for flattening and grains