feat(build): Make cleanup-markdown feature additive #1952
Conversation
| @@ -25,7 +25,7 @@ syn = "2.0" | |||
| [features] | |||
| default = ["transport", "prost"] | |||
| prost = ["prost-build", "dep:prost-types"] | |||
| cleanup-markdown = ["prost", "prost-build/cleanup-markdown"] | |||
| cleanup-markdown = ["prost-build?/cleanup-markdown"] | |||
There was a problem hiding this comment.
Why is the previous setup non-additive?
There was a problem hiding this comment.
The cleanup-markdown feature does not assume prost in terms of meaning, so I used the term additive here in the sense that it will remove the behavior that implicitly enables prost and make it possible to be compatible with other codecs in the future. In fact, it is additive at present, so there may be a more appropriate representation.
There was a problem hiding this comment.
Should there be some added documentation to make it clearer that cleanup-markdown will do nothing unless prost is also enabled?
There was a problem hiding this comment.
Updated the document.
tottoto
force-pushed
the
make-cleanup-markdown-feature-additive
branch
from
3f919f0
to
93d74f4
Compare
tonic-build/src/lib.rs
Outdated
| @@ -4,7 +4,8 @@ | |||
| //! # Feature flags | |||
| //! | |||
| //! - `cleanup-markdown`: Enables cleaning up documentation from the generated code. Useful | |||
| //! when documentation of the generated code fails `cargo test --doc` for example. | |||
| //! when documentation of the generated code fails `cargo test --doc` for example. `prost` | |||
There was a problem hiding this comment.
I'd suggest adding "The" here: "The prost feature [..]".
There was a problem hiding this comment.
Applied the suggestion.
tottoto
force-pushed
the
make-cleanup-markdown-feature-additive
branch
from
93d74f4
to
5a53262
Compare
Makes cleanup-markdown feature additive.