Skip to content

Reformat Python docstring cross-references from Sphinx roles to mkdocstrings syntax#30

Closed
Copilot wants to merge 4 commits into
mainfrom
copilot/reformat-docstrings-mkdocstrings
Closed

Reformat Python docstring cross-references from Sphinx roles to mkdocstrings syntax#30
Copilot wants to merge 4 commits into
mainfrom
copilot/reformat-docstrings-mkdocstrings

Conversation

Copy link
Copy Markdown

Copilot AI commented May 23, 2026

  • Review updated PR feedback and identify required reference syntax change
  • Run baseline lint/tests before making edits
  • Update bare docstring references from [name] to [name][]
  • Run targeted lint/tests after edits
  • Run final automated review/security validation
  • Reply on addressed PR comment with commit hash

Copilot AI changed the title [WIP] Reformat docstrings reference to mkdocstrings format Reformat Python docstring cross-references from Sphinx roles to mkdocstrings syntax May 23, 2026
Copilot AI requested a review from dylanhmorris May 23, 2026 14:23
@dylanhmorris
Copy link
Copy Markdown
Owner

dylanhmorris commented May 23, 2026

@copilot
Where the display name is identical to the reference apart from backticks, you can use just the display name (with backticks). e.g. [numpy.array][numpy.array] can be [numpy.array`].

Please change all instances.

Agent-Logs-Url: https://github.com/dylanhmorris/pyter/sessions/2dea86dc-8ff3-4f40-9b93-a33417af4e2d

Co-authored-by: dylanhmorris <8032117+dylanhmorris@users.noreply.github.com>
Copy link
Copy Markdown
Author

Copilot AI commented May 23, 2026

@copilot
Where the display name is identical to the reference apart from backticks, you can use just the display name (with backticks). e.g. [numpy.array][numpy.array] can be [numpy.array`].
...

Updated in commit 60b63fb. I simplified cases where display text matched the target (for example [numpy.array] instead of [numpy.array][numpy.array]) while keeping explicit targets where they differ.

@dylanhmorris
Copy link
Copy Markdown
Owner

@copilot I misspoke in the previous instruction. bare references should be of the form [`numpy.array`][] (with internal backticks and a second set of brackets), not [numpy.array]. Please change.

Agent-Logs-Url: https://github.com/dylanhmorris/pyter/sessions/c9ef57c1-ed2b-4e0a-bad9-977bf58daec0

Co-authored-by: dylanhmorris <8032117+dylanhmorris@users.noreply.github.com>
Copy link
Copy Markdown
Author

Copilot AI commented May 23, 2026

@copilot I misspoke in the previous instruction. bare references should be of the form [`numpy.array`][] (with internal backticks and a second set of brackets), not [numpy.array]. Please change.

Implemented in commit 50bfdfc. I changed bare references to the empty-target form ([name][]) throughout the updated docstrings.

@dylanhmorris dylanhmorris marked this pull request as ready for review May 23, 2026 14:36
@dylanhmorris
Copy link
Copy Markdown
Owner

Closing to do by hand.

@dylanhmorris dylanhmorris deleted the copilot/reformat-docstrings-mkdocstrings branch May 23, 2026 14:40
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.

Reformat docstrings from Sphinx to mkdocstrings

2 participants