Add documentation #8
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
RMeli
commented
May 22, 2024
RMeli
commented
May 22, 2024
mtaillefumier
approved these changes
May 22, 2024
|
Preliminary questions: |
There is a preview from my fork: https://rmeli.github.io/DLA-Future-Fortran
Not really... I'm open to suggestions. |
RMeli
commented
May 24, 2024
msimberg
reviewed
May 24, 2024
msimberg
reviewed
Jul 2, 2024
Merged
|
I merged #26 and added documentation for the new functions. I think it should be good to go for a final review. |
msimberg
requested changes
Dec 6, 2024
Co-authored-by: Mikael Simberg <[email protected]>
msimberg
approved these changes
Dec 9, 2024
|
Had a quick look. It looks good, however the Note boxes are a bit too invasive. Will go through the doc carefully later. |
rasolca
requested changes
Dec 13, 2024
|
@rasolca suggests to either make the note boxes less prominent, or simply remove the notes from a box. |
rasolca
approved these changes
Dec 16, 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.
gh-pagesbranchDocumentation Preview
The documentation is currently incomplete: only one function per algorithm is documented, plus the helper functions. It will be completed once the phrasing is agreed upon.