support docs on 'define_named_enum' #5993
Merged
+66
−4
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.
Description
This patch allows
define_name_enum!(..)
macro to accept docs comment.This is needed in case one wants to use this macro in some packages (like stacks-signer) is defined
#![forbid(missing_docs)]
attribute, otherwise a compilation error is emitted (see issue #5992 for related analisys)Applicable issues
define_named_enum!
not play nicely with#!forbid(missing_docs)
#5992Additional info (benefits, drawbacks, caveats)
The patch is backwards compatible where
define_name_enum
is used without docs comment.Basically the docs comment are managed as optional within the macro generation.
Checklist
docs/rpc/openapi.yaml
andrpc-endpoints.md
for v2 endpoints,event-dispatcher.md
for new events)clarity-benchmarking
repobitcoin-tests.yml