This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Hyphens not generated for split-words in a "note" directive
Type: behavior Stage:
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Ido Michael, docs@python, rhettinger, zach.ware
Priority: normal Keywords:

Created on 2020-03-01 18:31 by rhettinger, last changed 2022-04-11 14:59 by admin.

Messages (3)
msg363075 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-03-01 18:31
The justification algorithm for the docs will sometimes split words at the end of a line and will add a hyphen to indicate the continuation.   This works in most text but is broken within a "note" directive.

For example, there dangling "im" split of "implemenation" at the end of the third line in the note at:
https://docs.python.org/3/library/functools.html#functools.total_ordering

Contrast this with the correct "sup-" split of "supplies" in the first sentence.
msg363082 - (view) Author: Ido Michael (Ido Michael) * Date: 2020-03-01 19:35
Looks like a bug in the dev repo? What's the class responsible for rendering the notes?

I can take this
msg363125 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2020-03-02 06:18
Is this not a Sphinx issue?
History
Date User Action Args
2022-04-11 14:59:27adminsetgithub: 83995
2020-03-02 06:18:27zach.waresetnosy: + zach.ware
messages: + msg363125
2020-03-01 19:35:36Ido Michaelsetnosy: + Ido Michael
messages: + msg363082
2020-03-01 18:31:42rhettingercreate