Skip to content

Commit

Permalink
fix: Newlines within type description not parsed correctly in docs (#942
Browse files Browse the repository at this point in the history
)

Goes back to stripping newlines for type descriptions specifically
(changed in #805) as those don't parse properly now
  • Loading branch information
jnumainville authored Oct 17, 2024
1 parent f79224a commit 7f03d95
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion sphinx_ext/deephaven_autodoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ def extract_list_item(node: docutils.nodes.list_item) -> ParamData:
Returns:
The param data
"""
field = node.astext().replace("\n", "<br />")
field = node.astext().replace("\n", " ")
try:
match = re.match(r"(.+?) \((.*?)\) -- (.+)", field, re.DOTALL)
if match is None:
Expand Down

0 comments on commit 7f03d95

Please sign in to comment.