Autosummary generates overly-long summaries if first line doesn't end with a period

barnabas79 avatarbarnabas79 created an issue

If a function/module/etc has a docstring that looks like this:

I am the summary

...but it didn't end with a period, and there IS a sentence that ends with a period later, so this whole thing will become the summary.

...then the entire thing will get included as the "summary". This was introduced by the fix to issue 943 - https://bitbucket.org/birkenfeld/sphinx/issue/943/autosummary-doesnt-always-get-first - which attempted to detect situations where the first sentence of a docstring spanned multiple lines.

Unfortunately, it doesn't include detection for situations like the one above, where blank lines are used to indicate the end of the "summary".

I have a patch, which detects blank lines, and will submit a pull request shortly...

Comments (4)

  1. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.