support doc_mode attribute to limit docs to a single language#5283
Draft
davidhewitt wants to merge 1 commit intoPyO3:mainfrom
Draft
support doc_mode attribute to limit docs to a single language#5283davidhewitt wants to merge 1 commit intoPyO3:mainfrom
doc_mode attribute to limit docs to a single language#5283davidhewitt wants to merge 1 commit intoPyO3:mainfrom
Conversation
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.
This is a prototype attempt at #5269
It actually works, which is pretty promising!
One big drawback of this is that if the docs are placed above the attribute, which I'd consider normal Rust style, then the
#[pyo3_doc_mode]attributes are evaluated before the#[pymodule]attribute, and this then causes compiler errors:We can probably improve the UX there so that an incorrect placement works better.
Or maybe there are other ideas entirely which are not placement sensitive?