Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #32 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 7 7
Lines 68 68
=========================================
Hits 68 68 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
znicholls
left a comment
znicholls
left a comment
There was a problem hiding this comment.
Super. Few things to clean up, then add a changelog entry then good to merge
| @@ -1,5 +1,5 @@ | |||
| """ | |||
| Wrappers of `m_error_v_creation` [TODO think about naming and x-referencing] | |||
| Wrappers of [`m_error_v_creation`](/fortran-api/module/m_error_v_creation.html) | |||
There was a problem hiding this comment.
oh very nice, I like it a lot
There was a problem hiding this comment.
| Wrappers of [`m_error_v_creation`](/fortran-api/module/m_error_v_creation.html) | |
| Wrappers of [`m_error_v_creation`](../fortran-api/module/m_error_v_creation.html) |
might need to be something like this, at least the current link doesn't work on https://example-fgen-basic--32.org.readthedocs.build/en/32/api/example_fgen_basic/error_v/creation/
|
|
||
| function create_error(inv) result(res_instance_index) | ||
| !! Wrapper around `m_error_v_creation.create_error` (TODO: x-ref) | ||
| !> Wrapper around `m_error_v_creation.create_error` ([[m_error_v_creation(module):create_error(function)]]) |
There was a problem hiding this comment.
| !> Wrapper around `m_error_v_creation.create_error` ([[m_error_v_creation(module):create_error(function)]]) | |
| !! Wrapper around `m_error_v_creation.create_error` ([[m_error_v_creation(module):create_error(function)]]) |
!> means document the thing below this. !! means document the thing above this. (this is mentioned somewhere in the Ford docs)
this is why the docs here for inv are wrong: https://example-fgen-basic--32.org.readthedocs.build/en/32/fortran-api/proc/create_error~2.html
| !! | ||
| !! See docstring of `m_error_v_creation.create_error` for details. | ||
| !! [TODO: x-ref] | ||
| !> See docstring of [[m_error_v_creation(module):create_error(function)]] for details. |
There was a problem hiding this comment.
| !> See docstring of [[m_error_v_creation(module):create_error(function)]] for details. | |
| !! See docstring of [[m_error_v_creation(module):create_error(function)]] for details. |
as above
|
|
||
| function create_errors(invs, n) result(res_instance_indexes) | ||
| !! Wrapper around `m_error_v_creation.create_errors` (TODO: x-ref) | ||
| !> Wrapper around `m_error_v_creation.create_errors` ([[m_error_v_creation(module):create_errors(function)]]) |
There was a problem hiding this comment.
| !> Wrapper around `m_error_v_creation.create_errors` ([[m_error_v_creation(module):create_errors(function)]]) | |
| !! Wrapper around `m_error_v_creation.create_errors` ([[m_error_v_creation(module):create_errors(function)]]) |
as above
| !! | ||
| !! See docstring of `m_error_v_creation.create_error` for details. | ||
| !! [TODO: x-ref] | ||
| !> See docstring of [[m_error_v_creation(module):create_errors(function)]] for details. |
There was a problem hiding this comment.
| !> See docstring of [[m_error_v_creation(module):create_errors(function)]] for details. | |
| !! See docstring of [[m_error_v_creation(module):create_errors(function)]] for details. |
as above
| @@ -1,4 +1,4 @@ | |||
| !> Error passing | |||
| !> *Error passing* | |||
There was a problem hiding this comment.
Is this a convention? Always put the title in * ?
There was a problem hiding this comment.
Not really. I was messing around, with the formatting.
There was a problem hiding this comment.
ok cool let's undo this before merging then
| @@ -1,5 +1,5 @@ | |||
| """ | |||
| Wrappers of `m_error_v_passing` [TODO think about naming and x-referencing] | |||
| Wrappers of [`m_error_v_passing`](/fortran-api/module/m_error_v_passing.html). | |||
There was a problem hiding this comment.
As above re links being broken in the preview
|
|
||
| function pass_error(inv_instance_index) result(res) | ||
| !! Wrapper around `m_error_v_passing.pass_error` (TODO: x-ref) | ||
| !> Wrapper around `m_error_v_passing.pass_error` [[m_error_v_passing(module):pass_error(function)]]. |
There was a problem hiding this comment.
| !> Wrapper around `m_error_v_passing.pass_error` [[m_error_v_passing(module):pass_error(function)]]. | |
| !! Wrapper around `m_error_v_passing.pass_error` [[m_error_v_passing(module):pass_error(function)]]. |
| !! | ||
| !! See docstring of `m_error_v_passing.pass_error` for details. | ||
| !! [TODO: x-ref] | ||
| !> See docstring of [[m_error_v_passing(module):pass_error(function)]] for details. |
There was a problem hiding this comment.
| !> See docstring of [[m_error_v_passing(module):pass_error(function)]] for details. | |
| !! | |
| !! See docstring of [[m_error_v_passing(module):pass_error(function)]] for details. |
|
|
||
| function pass_errors(inv_instance_indexes, n) result(res) | ||
| !! Wrapper around `m_error_v_passing.pass_errors` (TODO: x-ref) | ||
| !> Wrapper around `m_error_v_passing.pass_error` [[m_error_v_passing(module):pass_errors(function)]]. |
There was a problem hiding this comment.
| !> Wrapper around `m_error_v_passing.pass_error` [[m_error_v_passing(module):pass_errors(function)]]. | |
| !! Wrapper around `m_error_v_passing.pass_error` [[m_error_v_passing(module):pass_errors(function)]]. |
2 participants
Description
Added cross-references both in the Fortran and Python part.
Weirdly enough some
fortran-api/module/m_error_v.htmlcross references are not resolved at the time being.Checklist
Please confirm that this pull request has done the following:
Tests addedDocumentation added (where applicable)changelog/