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.

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

Fix missing signatures for docstrings in Markdown #457

Merged
merged 3 commits into from
Oct 11, 2023

Conversation

staticf0x
Copy link
Contributor

@staticf0x staticf0x commented Oct 10, 2023

Add function signatures to RST style docstrings.

Edited, I was confused before, in plaintext the signatures are there, in RST they're not.

@staticf0x staticf0x changed the title Fix missing signatures in format_docstring for non-rst docstrings Fix missing signatures in format_docstring in rst docstrings Oct 10, 2023
@ccordoba12 ccordoba12 added the enhancement New feature or request label Oct 10, 2023
@ccordoba12 ccordoba12 changed the title Fix missing signatures in format_docstring in rst docstrings Fix missing signatures in format_docstring in markdown docstrings Oct 10, 2023
@ccordoba12
Copy link
Member

Thanks @staticf0x for your contribution!

@krassowski, could you take a look at this one? Thanks!

Copy link
Contributor

@krassowski krassowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is right, thank you @staticf0x. Would you mind also adding a test case for this one?

@ccordoba12 ccordoba12 added this to the v1.9.0 milestone Oct 10, 2023
@ccordoba12 ccordoba12 changed the title Fix missing signatures in format_docstring in markdown docstrings Fix missing signatures in format_docstring for Markdown docstrings Oct 10, 2023
@ccordoba12 ccordoba12 changed the title Fix missing signatures in format_docstring for Markdown docstrings Fix missing signatures for Markdown docstrings Oct 10, 2023
@staticf0x
Copy link
Contributor Author

@krassowski thanks, added!

@ccordoba12 ccordoba12 changed the title Fix missing signatures for Markdown docstrings Fix missing signatures for docstrings in Markdown Oct 11, 2023
@ccordoba12 ccordoba12 merged commit 4f6aa20 into python-lsp:develop Oct 11, 2023
10 checks passed
@staticf0x staticf0x deleted the fix-missing-signatures branch October 12, 2023 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants