Process docstring cli testing #215
Merged
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
It's not easy to adapt the Sphinx extensions for usage in the cli or parser tests without Sphinx. Instead, add direct process_docstring() functions for the simple use cases without extension setup or configuration.
Move away from doccompat, and use the extensions for docstring processing.
Add --process-docstring option to use the extension for docstring processing. Leave the --compat option in place for now, but we might want to deprecate and remove it going forward.
Now that the cli supports --process-docstring, we can handle transform also in the cli tests, and skip two fewer tests.
BrunoMSantos
approved these changes
Nov 14, 2023
| 'javadoc-basic', | ||
| 'javadoc-liberal', | ||
| 'kernel-doc' | ||
| ], | ||
| help='Compatibility options. See cautodoc_compat.') |
There was a problem hiding this comment.
Consider raising DeprecationWarning 🤷♂️
There was a problem hiding this comment.
Side note: we may also want to institutionalize a deprecation policy so we have a regular, well advertised schedule for dropping things. We have an important user now and everything <.<
There was a problem hiding this comment.
Yeah, the deprecation has been haphazard so far. If it's release based, I guess it'll have to be major releases. And we're not even at 1.0. 😁
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.
No description provided.