Fix malformed :obj: cross-reference roles in docstrings - #3065
Open
antonwolfy wants to merge 1 commit into
Open
Conversation
The See Also entries for dpnp.argsort and dpnp.histogram_bin_edges used `obj:` instead of `:obj:` (missing the leading colon), so the role was not recognized and rendered as literal "obj:" text in the API docs. Add the missing colon so the cross-references render as proper links.
antonwolfy
marked this pull request as ready for review
September 9, 2026 16:42
antonwolfy
requested review from
ndgrigorian and
vlad-perevezentsev
as code owners
September 9, 2026 16:42
Contributor
|
View rendered docs @ https://intelpython.github.io/dpnp/pull/3065/index.html |
Contributor
|
Array API standard conformance tests for dpnp=0.21.0dev8=py314ha0e2e8e_6 ran successfully. |
Collaborator
|
coverage: 78.495% (+0.003%) from 78.492% — fix-obj-role-typos into master |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two
See Alsoentries usedobj:instead of:obj:(missing the leading colon), so Sphinx did not recognize the cross-reference role and rendered it as literalobj:text in the API docs:dpnp.argsort— thedpnp.take_along_axisentry rendered as "…from obj: dpnp.argsort…"dpnp.histogram— thedpnp.histogram_bin_edgesentry rendered as "…by the obj:dpnp.histogram function"Adding the missing colon makes both render as proper cross-reference links. This is a docstring-only change with no functional impact.