Added cross-references #32

mzecc · 2025-09-08T16:37:09Z

Description

Added cross-references both in the Fortran and Python part.
Weirdly enough some fortran-api/module/m_error_v.html cross references are not resolved at the time being.

Checklist

Please confirm that this pull request has done the following:

[ ]~~Tests added~~
[ ]~~Documentation added (where applicable)~~
Changelog item added to changelog/

codecov · 2025-09-08T16:37:46Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (ca2a5f5) to head (b693360).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

znicholls

Super. Few things to clean up, then add a changelog entry then good to merge

znicholls · 2025-09-10T07:57:16Z

src/example_fgen_basic/error_v/creation.py

@@ -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)


oh very nice, I like it a lot

Suggested change

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/

znicholls · 2025-09-10T08:00:49Z

src/example_fgen_basic/error_v/creation_wrapper.f90


    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)]])


Suggested change

!> 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

znicholls · 2025-09-10T08:01:24Z

src/example_fgen_basic/error_v/creation_wrapper.f90

        !!
-        !! 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.


Suggested change

!> 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

znicholls · 2025-09-10T08:01:34Z

src/example_fgen_basic/error_v/creation_wrapper.f90


    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)]])


Suggested change

!> 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

znicholls · 2025-09-10T08:01:42Z

src/example_fgen_basic/error_v/creation_wrapper.f90

        !!
-        !! 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.


Suggested change

!> 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

znicholls · 2025-09-10T08:05:56Z

src/example_fgen_basic/error_v/passing.f90

@@ -1,4 +1,4 @@
-!> Error passing
+!> *Error passing*


Is this a convention? Always put the title in * ?

Not really. I was messing around, with the formatting.

ok cool let's undo this before merging then

znicholls · 2025-09-10T08:06:11Z

src/example_fgen_basic/error_v/passing.py

@@ -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).


As above re links being broken in the preview

znicholls · 2025-09-10T08:06:29Z

src/example_fgen_basic/error_v/passing_wrapper.f90


    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)]].


Suggested change

!> 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)]].

znicholls · 2025-09-10T08:06:39Z

src/example_fgen_basic/error_v/passing_wrapper.f90

-        !!
-        !! 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.


Suggested change

!> 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.

znicholls · 2025-09-10T08:06:46Z

src/example_fgen_basic/error_v/passing_wrapper.f90


    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)]].


Suggested change

!> 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)]].

Added x-refs

b693360

znicholls approved these changes Sep 10, 2025

View reviewed changes

	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)

	!> 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)]])

	!> 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.

	!> 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(module):pass_error(function)]] for details.
	!!
	!! See docstring of [[m_error_v_passing(module):pass_error(function)]] for details.

Added cross-references #32

Are you sure you want to change the base?

Added cross-references #32

Uh oh!

Conversation

mzecc commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

codecov bot commented Sep 8, 2025

Codecov Report

Uh oh!

znicholls left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mzecc commented Sep 8, 2025 •

edited

Loading