You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
def foo():
"""
Does foo, i.e. fooing the thing.
"""
then build with make html and open the built docs.
This results in
i.e. the docstring summary is cut.
Expected behavior
Not cutting the summary.
The summary detection logic is at https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/ext/autosummary/__init__.py#L526 (basically splitting at dots followed by whitespace). I can think of two ways for fixing it: either check that the dot is not followed by a lowercase character, or just special-case i.e. and perhaps a couple of other abbreviations.
Environment info
OS: linux
Python version: 3.8.1
Sphinx version: 3.1.0
Sphinx extensions: autosummary
Additional context
N/A
The text was updated successfully, but these errors were encountered:
Describe the bug
If a docstring's first sentence contains an abbreviation such as
i.e.
, autosummary incorrectly cuts the summary immediately after the abbreviation.To Reproduce
Steps to reproduce the behavior:
edit
index.html
to containand
foo.py
to containthen build with
make html
and open the built docs.This results in
i.e. the docstring summary is cut.
Expected behavior
Not cutting the summary.
The summary detection logic is at https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/ext/autosummary/__init__.py#L526 (basically splitting at dots followed by whitespace). I can think of two ways for fixing it: either check that the dot is not followed by a lowercase character, or just special-case
i.e.
and perhaps a couple of other abbreviations.Environment info
Additional context
N/A
The text was updated successfully, but these errors were encountered: