Skip to content

docs: minor cleanup in tridiagonal solver#381

Merged
FlorianDeconinck merged 3 commits into
NOAA-GFDL:developfrom
romanc:romanc/docs-cleanup
Feb 13, 2026
Merged

docs: minor cleanup in tridiagonal solver#381
FlorianDeconinck merged 3 commits into
NOAA-GFDL:developfrom
romanc:romanc/docs-cleanup

Conversation

@romanc
Copy link
Copy Markdown
Collaborator

@romanc romanc commented Feb 13, 2026

Description

Small PR to improve how the auto-gen docs look like for the tridiagonal solver.

Before After
image image

Note how deleting the (in) / (out) intent is enabling the auto-docs system to detect the type correctly. Do we need to keep (in) / (out) somewhere?

Also fixes a stale reference (in docs) to the previous NDSLNamelist, which was removed with PR #297.

How has this been tested?

By building docs locally.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas: N/A
  • I have made corresponding changes to the documentation (e.g. add new modules to docs/docstrings/)
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules: N/A
  • New check tests, if applicable, are included: N/A

@romanc romanc marked this pull request as ready for review February 13, 2026 08:43
@romanc romanc changed the title docs: minor cleanup docs: minor cleanup in tridiagonal solver Feb 13, 2026
@FlorianDeconinck FlorianDeconinck added this pull request to the merge queue Feb 13, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Feb 13, 2026
@FlorianDeconinck
Copy link
Copy Markdown
Collaborator

Let's bring the in/out thing at stand up - we put it everywhere

@FlorianDeconinck FlorianDeconinck added this pull request to the merge queue Feb 13, 2026
@romanc
Copy link
Copy Markdown
Collaborator Author

romanc commented Feb 13, 2026

Let's bring the in/out thing at stand up - we put it everywhere

Sounds good - I'm not particularly against it. The way it's done now (i.e. the way it was copied over from the Fortran), it overrides any type that might have been detected.

Merged via the queue into NOAA-GFDL:develop with commit 188b957 Feb 13, 2026
7 checks passed
@romanc romanc deleted the romanc/docs-cleanup branch February 13, 2026 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants