Skip to content

Remove RST formatting in docstrings outside of API code#929

Merged
maddenp-cu merged 4 commits into
ufs-community:mainfrom
maddenp-cu:no-non-api-rst-docstrings
Jun 12, 2026
Merged

Remove RST formatting in docstrings outside of API code#929
maddenp-cu merged 4 commits into
ufs-community:mainfrom
maddenp-cu:no-non-api-rst-docstrings

Conversation

@maddenp-cu

Copy link
Copy Markdown
Collaborator

Synopsis

Since only docstrings in API code will be rendered to HTML, RST formatting elsewhere is unnecessary, inconsistent, and requires maintenance.

Type

  • Documentation

Impact

  • This is a non-breaking change (existing functionality continues to work as expected)

Checklist

  • I have added myself and any co-authors to the PR's Assignees list.
  • I have reviewed the documentation and have made any updates necessitated by this change.
  • Where helpful, I have written comments in this PR's Files changed view to assist reviewers.

@maddenp-cu maddenp-cu self-assigned this Jun 12, 2026
@maddenp-cu maddenp-cu marked this pull request as ready for review June 12, 2026 16:47
@maddenp-cu maddenp-cu merged commit 9036a63 into ufs-community:main Jun 12, 2026
2 checks passed
@maddenp-cu maddenp-cu deleted the no-non-api-rst-docstrings branch June 12, 2026 17:36
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