Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Make fallback for changed get_signature_prefix() #9833

Merged
merged 3 commits into from Nov 10, 2021
Merged

Make fallback for changed get_signature_prefix() #9833

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3599f7d
Make fallback for changed get_signature_prefix()
jakobandersen Nov 9, 2021
d20cb96
Fix lint errors
jakobandersen Nov 9, 2021
63bd4b8
Use warnings.warn and deprecation warning
jakobandersen Nov 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 11 additions & 1 deletion sphinx/domains/python.py
View file
Open in desktop
Expand Up @@ -495,7 +495,17 @@ def handle_signature(self, sig: str, signode: desc_signature) -> Tuple[str, str]

sig_prefix = self.get_signature_prefix(sig)
if sig_prefix:
signode += addnodes.desc_annotation(str(sig_prefix), '', *sig_prefix)
if type(sig_prefix) is str:
warnings.warn(
"Python directive method get_signature_prefix()"
" returning a string is deprecated."
" It must now return a list of nodes."
" Return value was '{}'.".format(sig_prefix),
RemovedInSphinx50Warning)
signode += addnodes.desc_annotation(sig_prefix, '', # type: ignore
nodes.Text(sig_prefix)) # type: ignore
else:
signode += addnodes.desc_annotation(str(sig_prefix), '', *sig_prefix)

if prefix:
signode += addnodes.desc_addname(prefix, prefix)
Expand Down