Repository navigation
fix(vendor): make wrapped const comments render as written (#1846, #1847) - #1871
Conversation
|
Verdict: GOOD TO GO at
Non-blocking:
|
|
Verdict: NEEDS CHANGES at The cause is the new |
db11292 to
b20fe2f
Compare
|
Verdict: NEEDS CHANGES at One required change, a false comment. |
b20fe2f to
b671834
Compare
|
Verdict: NEEDS CHANGES at
One change left, the same wording error I've flagged on #1877 and #1881. The new |
) - Vendor.wrap_comment puts a space after a URL reference that another bracket follows, which docutils autolinked into the next citation, and backslash-escapes a leading reST enumerator such as (S). - Vendor.wrap_comment and AppType.tabulate pass break_on_hyphens=False: a continued line joins with a space, so a hyphen split rendered "run- time" and cut a list-table cell's URL short. - AppType.wrap_comment takes its lines from the base instead of wrapping on its own, so it gets both fixes; nothing it emits trips the #1846 cases yet. - Re-render the affected const comments and AppType tables offline from the committed text, with no crawl. Members, values and code are unchanged. - Add tests/vendor/test_vendor_wrap_comment_unit.py. - Map docutils in tests/_dependency_gates.py, via Sphinx, and record the HAS_DOCUTILS gate as deliberately dark on test and gate. Closes #1846 Closes #1847
b671834 to
adf8f9c
Compare
|
Verdict: GOOD TO GO at
The reason states no count, and |
|
Coverage: 90.05% (unit tier, Python 3.15,
Per-file detail: the |
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible: N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elsebracket follows, which docutils autolinked into the next citation, and
backslash-escapes a leading reST enumerator such as (S).
continued line joins with a space, so a hyphen split rendered "run- time"
and cut a list-table cell's URL short.
its own, so it gets both fixes; nothing it emits trips the fix(vendor): generated comments run a URL reference into the next bracket and start a line with
(S), which reST misrenders #1846 cases yet.committed text, with no crawl. Members, values and code are unchanged.
Closes #1846
Closes #1847
The const files were re-rendered offline from their committed text, so no crawler ran. Each is AST-identical to
mainwith docstrings blanked, and a member dump of every changed module is byte-identical.