Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Make use of the :py:deco: role in documentation #131426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Viicos opened this issue Mar 18, 2025 · 3 comments
Closed

Make use of the :py:deco: role in documentation #131426

Viicos opened this issue Mar 18, 2025 · 3 comments
Labels
docs Documentation in the Doc dir

Comments

@Viicos
Copy link
Contributor

Viicos commented Mar 18, 2025

Documentation

The :py:deco: role was added in Sphinx 8.2.0. The minimum required Sphinx version is 8.2.

Should we make use of this role to reference decorators in the documentation?

Crossref #105812, I can also close my issue in favor of this one.

cc @AA-Turner

@Viicos Viicos added the docs Documentation in the Doc dir label Mar 18, 2025
@picnixz
Copy link
Member

picnixz commented Mar 18, 2025

At first, I was tempted to close this one in favor of the other, but the other only discussed about adding the feature and not about using an existing one. If we need to re-use an issue later because some decorators roles are missing, I think it's better to use this one instead. So I think it's perhaps better to close the other as there is nothing to discuss about the "new" feature? (only its adoption which this issue could solely track).

cc @erlend-aasland @AlexWaygood @CAM-Gerlach as they were involved in the original issue

@erlend-aasland
Copy link
Contributor

I think it is fine to reuse/retarget the existing issue.

@picnixz
Copy link
Member

picnixz commented Mar 18, 2025

Ok, let's retarget the old issue then (I'll let you update the body)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
Status: Todo
Development

No branches or pull requests

3 participants