refactor docstring generation code #2904
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
mejrs
approved these changes
Jan 24, 2023
davidhewitt
force-pushed
the
simpler-doc
branch
from
ae89c62 to
b569550
Compare
davidhewitt
force-pushed
the
simpler-doc
branch
from
b569550 to
e4a3d28
Compare
|
bors r=mejrs |
|
Build succeeded: |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
As a first step towards #2866 this is a tweak to the macro code which generates Python docstrings. This PR refactors the behaviour so that instead of always creating a
concat!expression to generate a nul-terminated string, this will only happen if a Rust 1.54+ macro doc is present (e.g.#[doc = include_str!(...)]).The default case now just collects all the
#[doc]attributes into a single string.This should make it easier to factor out the
text_signatureformatting, and avoids wasting compile time invoking theconcat!macro when not necessary.