Repository navigation
docs(const): drop version directives from generated tables (#1884) - #1895
Merged
Merged
Conversation
- Remove the versionadded and versionchanged directives from the template text of the ftp/command, http/method, ipv6/extension_header, pcapng/option_type, pcapng/tls_key_label, reg/apptype/apptype and tcp/flags crawlers, and identically from the committed const modules, without re-crawling. - Move each note onto its hand-written page under docs/source/pcapkit/const, as #1848 did, since the crawlers regenerate the modules (#1872). - Keep the directives on the crawler framework's own code and on the hand-written AppType.wrap_comment and AppType.tabulate crawler methods. - Pin that no const module and no crawler template carries a directive, and that the moved notes are on their pages; the #1824 test now expects no directive in Command.get's docstring. Closes #1884
Owner
Author
|
Verdict: GOOD TO GO at
Two gaps, neither blocking. The regex at |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 elseRemoves the version directives from the template text of the
ftp/command,http/method,ipv6/extension_header,pcapng/option_type,pcapng/tls_key_label,reg/apptype/apptypeandtcp/flagscrawlers. The same blocks come out of the committed const modules, with no re-crawl.Each note moves onto its hand-written page under
docs/source/pcapkit/const/, as fix(const)!: name LLACode codes 0 and 2 as RFC 5568 does (#1848) #1872 did, keeping the original version.Directives on the crawler framework's own code stay. That covers
pcapkit/vendor/__init__.py,__main__.pyanddefault.py, plus the apptype crawler's ownwrap_commentandtabulatemethods, since none of them is template text.tests/project/test_no_version_directives_in_generated_tables_1884_unit.pyfinds template text by parsing each crawler, not from a list of exempt files. It fails onmainand passes here.tests/vendor,tests/const,tests/projectand the tier guard pass. No Sphinx build was run.Closes #1884