Add documentation #8
Conversation
|
Preliminary questions: |
There is a preview from my fork: https://rmeli.github.io/DLA-Future-Fortran
Not really... I'm open to suggestions. |
|
I merged #26 and added documentation for the new functions. I think it should be good to go for a final review. |
Co-authored-by: Mikael Simberg <[email protected]>
| !! Cholesky decomposition for a distributed single-precision real symmetric positive definite matrix \(\mathbf{A}\) | ||
| !! {!docs/snippets/note-host-matrix.md!} | ||
| character, intent(in) :: uplo | ||
| !! {!docs/snippets/uplo.md!} | ||
| integer, intent(in) :: n | ||
| !! {!docs/snippets/n.md!} | ||
| real(kind=sp), dimension(:, :), target, intent(inout) :: a | ||
| integer, intent(in) :: ia, ja | ||
| !! {!docs/snippets/a.md!} | ||
| integer, intent(in) :: ia | ||
| !! {!docs/snippets/ia.md!} | ||
| integer, intent(in) :: ja | ||
| !! {!docs/snippets/ja.md!} | ||
| integer, dimension(9), intent(in) :: desca | ||
| !! {!docs/snippets/desca.md!} | ||
| integer, target, intent(out) :: info | ||
| !! {!docs/snippets/info.md!} |
There was a problem hiding this comment.
I admit I didn't expect to see this here, but it's really nice (I'm referring to the inclusion of snippets)! My only concern is that this means there are no (readable) docs just while browsing the code, but I think it's still a net benefit to ensure the published documentation is consistent. Most users will not be browsing the code.
There was a problem hiding this comment.
I too thought that it is a net benefit. (You have to look only at a few files to spot all my typos... =P)
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.