hawkmoth.ext.transformations and hawkmoth.util.doccompat deprecation #246
Conversation
This file contains 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
jnikula
changed the title
jnikula
force-pushed
the
transformations-deprecation
branch
from
7da8f82
to
befd014
Compare
|
Also remove the deprecated cautodoc_root and cautodoc_clang config options. |
BrunoMSantos
approved these changes
Sep 11, 2024
…doccompat The introduction of the cautodoc_transformations config option was a mistake to begin with. The right way forward is the hawkmoth-process-docstring event. The hawkmoth.ext.transformations extension was introduced as a temporary solution to not immediately pull the plug on cautodoc_transformations. It's time to deprecate the cautodoc_transformations config, the hawkmoth.ext.transformations extension, and the hawkmoth.util.doccompat module. Everyone should move to either the hawkmoth.ext.javadoc or hawkmoth.ext.napoleon extensions, or if they're not enough, implement their own extensions through the hawkmoth-process-docstring event. The javadoc/doxygen helpers in doccompat are inferior to the hawkmoth.ext.javadoc extension, and the kernel-doc "support" is two regexes in a row. Functionally, the deprecation means 1) not loading hawkmoth.ext.transformations automatically, i.e. you have to manually add it to extensions in conf.py, and 2) deprecation messages on loading the extension and the module.
…essing The hawkmoth.util.doccompat module has been deprecated. Remove the --compat option and the dependency on the module. The alternative is to use the --process-docstring option. It does lack the kernel-doc support, but it was simplistic to begin with.
The cautodoc_root and cautodoc_clang config options have been deprecated in favour of hawkmoth_root and hawkmoth_clang since Hawkmoth v0.13.0. Remove them.
jnikula
force-pushed
the
transformations-deprecation
branch
from
befd014
to
61436c1
Compare
Double-checked, should not have an impact. |
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.
Time to start getting rid of
cautodoc_transformations,hawkmoth.ext.transformations, andhawkmoth.util.doccompat. The better alternatives i.e.hawkmoth.ext.javadocextension andhawkmoth-process-docstringevent have been in place since v0.13.