Update fix_ampersands documentation for behavior with existing entities
|Reported by:||Jerry||Owned by:||nobody|
|Cc:||Triage Stage:||Ready for checkin|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
fix_ampersands doesn’t replace all ampersands with & entities; it attempts, usually successfully, to exclude named entities and numeric character references while converting all ampersands that do need replacing. This (and its behavior in some edge cases, noted at ticket:16066) should be documented.
Adds two lines under fix_ampersands in docs/_build/html/ref/templates/builtins.html:
Named entities and numeric character references are not replaced. If ``value`` is ``Pepé Le Pew``, the output will remain ``Pepé Le Pew``. In some edge cases--such as abbreviations followed by semicolons--this filter will not replace ampersands that need replacing. If ``value`` is ``Darrin, run that past R&D; Betty…``, the output will remain unchanged because ``&D;`` resembles a named entity.
Change History (7)
comment:1 Changed 5 years ago by
|Patch needs improvement:||unset|
|Triage Stage:||Unreviewed → Accepted|