Improved the violation message of DOC105: the arguments with inconsistent
type hints are now shown in the violation message to make violation
correction much easier
A new config option --show-filenames-in-every-violation-message (or
-sfn), which makes it more convenient to jump to the corresponding line
in IDEs by clicking on the violation message in the terminal
All postprocessors are now run on heading content.
Footnote references are now stripped from heading content. Fixes #660.
A more robust striptags is provided to convert headings to plain text.
Unlike, the markupsafe implementation, HTML entities are not unescaped.
The plain text name, rich html, and unescaped raw data-toc-label are
saved to toc_tokens, allowing users to access the full rich text content of
the headings directly from toc_tokens.
The value of data-toc-label is sanitized separate from heading content
before being written to name. This fixes a bug which allowed markup through
in certain circumstances. To access the raw unsanitized data, retrieve the
value from token['data-toc-label'] directly.
An html.unescape call is made just prior to calling slugify so that
slugify only operates on Unicode characters. Note that html.unescape is
not run on name, html, or data-toc-label.
The functions get_name and stashedHTML2text defined in the toc extension
are both deprecated. Instead, third party extensions should use some
combination of the new functions run_postprocessors, render_inner_html and
striptags.
Fixed
Include scripts/*.py in the generated source tarballs (#1430).
Ensure lines after heading in loose list are properly detabbed (#1443).
Give smarty tree processor higher priority than toc (#1440).
Permit carets (^) and square brackets (]) but explicitly exclude
backslashes (\) from abbreviations (#1444).
In attribute lists (attr_list, fenced_code), quoted attribute values are
now allowed to contain curly braces (}) (#1414).
Release 3.5.2
Fixed
Fix type annotations for convertFile - it accepts only bytes-based buffers.
Also remove legacy checks from Python 2 (#1400)
Remove legacy import needed only in Python 2 (#1403)
Fix typo that left the attribute AdmonitionProcessor.content_indent unset
(#1404)
Fix edge-case crash in InlineProcessor with AtomicString (#1406).
Fix edge-case crash in codehilite with an empty code tag (#1405).
Improve and expand type annotations in the code base (#1401).
All postprocessors are now run on heading content.
Footnote references are now stripped from heading content. Fixes #660.
A more robust striptags is provided to convert headings to plain text.
Unlike, the markupsafe implementation, HTML entities are not unescaped.
The plain text name, rich html, and unescaped raw data-toc-label are
saved to toc_tokens, allowing users to access the full rich text content of
the headings directly from toc_tokens.
The value of data-toc-label is sanitized separate from heading content
before being written to name. This fixes a bug which allowed markup through
in certain circumstances. To access the raw unsanitized data, retrieve the
value from token['data-toc-label'] directly.
An html.unescape call is made just prior to calling slugify so that
slugify only operates on Unicode characters. Note that html.unescape is
not run on name, html, or data-toc-label.
The functions get_name and stashedHTML2text defined in the toc extension
are both deprecated. Instead, third party extensions should use some
combination of the new functions run_postprocessors, render_inner_html and
striptags.
Fixed
Include scripts/*.py in the generated source tarballs (#1430).
Ensure lines after heading in loose list are properly detabbed (#1443).
Give smarty tree processor higher priority than toc (#1440).
Permit carets (^) and square brackets (]) but explicitly exclude
backslashes (\) from abbreviations (#1444).
In attribute lists (attr_list, fenced_code), quoted attribute values are
now allowed to contain curly braces (}) (#1414).
[3.5.2] -- 2024-01-10
Fixed
Fix type annotations for convertFile - it accepts only bytes-based buffers.
Also remove legacy checks from Python 2 (#1400)
Remove legacy import needed only in Python 2 (#1403)
Fix typo that left the attribute AdmonitionProcessor.content_indent unset
(#1404)
Fix edge-case crash in InlineProcessor with AtomicString (#1406).
Fix edge-case crash in codehilite with an empty code tag (#1405).
Improve and expand type annotations in the code base (#1401).
This release brings support for pytest 8, a couple of bug fixes and many improvements to the cookiecutter template.
Upgrading
Once you upgraded, you'll be able to upgrade to pytest 8, and indirectly to sybil 6, which includes types hints. If you do so, you should remove the mypy exception for sybil in the pyproject.toml file.
Search for the tool.mypy.overrides section and remove the "sybil", "sybil.*" enties from the module list.
Cookiecutter template
To upgrade without regenerating the project, you can follow these steps:
Run the following command to add the new pylint ignore rules:
sed '/ # Checked by flake8/a\ "redefined-outer-name",\n "unused-import",' -i pyproject.toml
dependabot[bot]
commented
4 months ago
Bumps the required group with 11 updates in the / directory:
0.3.20.4.15.12.05.13.23.4.43.62.0.02.1.11.0.41.0.59.3.19.5.250.23.00.25.10.7.00.9.21.5.11.10.03.4.2.103.6.0.202403160.7.00.9.2Updates
pydoclintfrom 0.3.2 to 0.4.1Release notes
Sourced from pydoclint's releases.
... (truncated)
Changelog
Sourced from pydoclint's changelog.
... (truncated)
Commits
af2c326Update changelog3a5e4b0Remove useless argument--src(#124)70eb3c8Fix double quotes in Literal type hint (#123)d2b4b99Include args with different type hints in DOC105 msg (#120)fa41757Add option to show filename for each violation msg (#119)b8b4396Add py312 to CI pipeline01893dfExclude venv folders in flake8 (#116)676847eDocumenting tool integration (#104)75e485bFix false positive DOC203 in property methods (#115)55c0fdeExplain why allow-init-docstring defaults to FalseUpdates
isortfrom 5.12.0 to 5.13.2Release notes
Sourced from isort's releases.
... (truncated)
Changelog
Sourced from isort's changelog.
Commits
c655831Merge pull request #2214 from PyCQA/version/5.13.2b4335b4Prepare version 5.13.2c36e43cMerge pull request #2184 from bp72/issue/2154e38702fMerge pull request #2213 from davidculley/confine-precommit-to-stagesee8d87fAdd fix for the error found by hypothesis5849ec2Apply the bracket fix from issue 471 only for use_parentheses=Truedf0e119confine pre-commit to stages9255bcaMerge pull request #2212 from PyCQA/bugfix/#2211-colors-extra5336d7dFix colors extras643d9c4Merge pull request #2210 from PyCQA/version/5.13.1Updates
markdownfrom 3.4.4 to 3.6Release notes
Sourced from markdown's releases.
... (truncated)
Changelog
Sourced from markdown's changelog.
... (truncated)
Commits
e524b8fBump version to 3.63d8afc6Allow attr_list quoted values to contain curly braces9edba85Refactor abbr escapinge4ab4a6Refactor TOC sanitationa18765cExplicitly omit carot and backslash from abbr421f1e8Give smarty tree processor higher priority than tocc334a3eEnsure lines after heading in loose list are properly detabbedea92856Update the license template so GitHub can detect ita2effd6Disable mkdocstrings show_symbol_type_toc option to work around searching iss...91f9a12Restore Attribute symbol type in mkdocstrings templateUpdates
mikefrom 2.0.0 to 2.1.1Release notes
Sourced from mike's releases.
Changelog
Sourced from mike's changelog.
Commits
0bdfe24Update version to 2.1.13351d5fExpand environment variables when injecting the mike plugin; resolves #217e4d83edUpdate version to 2.2.0.dev06e6cfbbUpdate version to 2.1.05773be9Fix CI7904925Further tests for deserializing Python objects duringinject_plugin01219bdAllow arbitrary Python object in YAML configac7b240Handle!relative(and any future constructors) in mkdocs.yml; resolves #199fdcc912Add--quietoption; resolves #210a39ea73Addset-default --allow-undefined; see #210Updates
mkdocs-macros-pluginfrom 1.0.4 to 1.0.5Changelog
Sourced from mkdocs-macros-plugin's changelog.
Commits
4bfda0bFix issue with changelog no longer displayed (#186)82c5cddMerge pull request #183 from marcospereira/add-short-tag298f07fAdd a short_tag attribute to git context428a015Remove include-markdown in webdoc, since it crashed readthedocs2161dd4Update .readthedocs.ymlc64a08dMerge pull request #182 from SimonMarquis/patch-11c1d2c4Fix typo inRich Markdown Pagesdocs9dba19eMerge branch 'master' of github.com:fralau/mkdocs_macros_plugin into master7da7089Add experimental logo0d36ddeAdd experimental logoUpdates
mkdocs-materialfrom 9.3.1 to 9.5.25Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
c8ee11fPrepare 9.5.25 release0ee1110Updated dependencies09f817dDocumentation86d3729Created new and better Insiders documentation (#7210)1b346ebFixed tags plugin crashing on numeric tags05af898Added --force-reinstall to insiders upgrade instructions (#7203)7368c7fUpdated Insiders changeloge8478d9Documentationd0be598Updated Insiders changelog721eefbUpdated Insiders changelogUpdates
mkdocstrings[python]from 0.23.0 to 0.25.1Release notes
Sourced from mkdocstrings[python]'s releases.
... (truncated)
Changelog
Sourced from mkdocstrings[python]'s changelog.
... (truncated)
Commits
e135869chore: Prepare release 0.25.1cb86e08fix: Always descend into sub-headings when re-applying their labela86ca7ddocs: Customize parameters color in ToCbc25b6adocs: Remove requirements link in readme87d8229chore: Prepare release 0.25.0c5b5f69refactor: Allow specifying name of template loggers7ff1681docs: Enable parameter headings253d215docs: Load inventories for MkDocs and Markdown1532b59feat: Supportonceparameter in logging methods, allowing to log a message ...d799d2ffeat: Support blank line between::: pathand YAML optionsUpdates
frequenz-repo-config[api]from 0.7.0 to 0.9.2Release notes
Sourced from frequenz-repo-config[api]'s releases.
... (truncated)
C... _Description has been truncated_