Skip to content

Fix missing signatures for docstrings in Markdown #457

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

Merged
merged 3 commits into from
Oct 11, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion pylsp/_utils.py
Original file line number Diff line number Diff line change
@@ -209,7 +209,6 @@ def format_docstring(
if markup_kind == "markdown":
try:
value = docstring_to_markdown.convert(contents)
return {"kind": "markdown", "value": value}
except docstring_to_markdown.UnknownFormatError:
# try to escape the Markdown syntax instead:
value = escape_markdown(contents)
51 changes: 51 additions & 0 deletions test/test_utils.py
Original file line number Diff line number Diff line change
@@ -9,6 +9,7 @@
from unittest import mock

from flaky import flaky
from docstring_to_markdown import UnknownFormatError

from pylsp import _utils
from pylsp.python_lsp import PythonLSPServer, start_io_lang_server
@@ -154,3 +155,53 @@ def test_clip_column():
assert _utils.clip_column(2, ["123\n", "123"], 0) == 2
assert _utils.clip_column(3, ["123\n", "123"], 0) == 3
assert _utils.clip_column(4, ["123\n", "123"], 1) == 3


@mock.patch("docstring_to_markdown.convert")
def test_format_docstring_valid_rst_signature(mock_convert):
"""Test that a valid RST docstring includes the function signature."""
docstring = """A function docstring.

Parameters
----------
a : str, something
"""

# Mock the return value to avoid depedency on the real thing
mock_convert.return_value = """A function docstring.

#### Parameters

- `a`: str, something
"""

markdown = _utils.format_docstring(
docstring,
"markdown",
["something(a: str) -> str"],
)["value"]

assert markdown.startswith(
_utils.wrap_signature("something(a: str) -> str"),
)


@mock.patch("docstring_to_markdown.convert", side_effect=UnknownFormatError)
def test_format_docstring_invalid_rst_signature(_):
"""Test that an invalid RST docstring includes the function signature."""
docstring = """A function docstring.

Parameters
----------
a : str, something
"""

markdown = _utils.format_docstring(
docstring,
"markdown",
["something(a: str) -> str"],
)["value"]

assert markdown.startswith(
_utils.wrap_signature("something(a: str) -> str"),
)