Mercurial > evolve
view .hgignore @ 5779:96ed73c5c6ca
doc: remove .strip() for a docstring
This shouldn't be necessary, and by stripping it (and removing the trailing
newline) it causes issues with Mercurial's doc/gendoc.py's RST output, since
there's no newline separating this string and the thing that comes after it.
I believe that the `.strip()` has been in there since the beginning, but I have
not found a reason for its existence. It's possible that this was required in
older Mercurial versions, but is no longer required? Notably, the tests (which
include an invocation of `hg help evolution`) still pass with this change.
### Alternatives considered
- Making gendoc.py robust against this. This was rejected since there's no need
for the .strip() as far as I can tell, and this is the only case I know of
that would need such logic.
author | Kyle Lippincott <spectral@google.com> |
---|---|
date | Wed, 17 Feb 2021 12:00:45 -0800 |
parents | aad37ffd7d58 |
children | ba316ce15040 |
line wrap: on
line source
syntax: re /figures/[^/]+\.png$ ^html/ \.pyc$ ~$ \.swp$ \.orig$ \.rej$ ^tests/.*\.err$ ^tests/easy_run.sh$ ^build/ ^dist/ ^MANIFEST$ ^docs/tutorials/.*\.rst$ \.ico$ tests/\.testtimes ^docs/training/graphs/ ^docs/training/html/ ^docs/training/index.html ^docs/training/graphviz-images/ ^docs/training/img/ ^docs/training/output/ ^docs/training/pandocfilters/