limit docs.rs to 5 API tags #679
Conversation
| const MAX_DOCS_RS_FEATURES: usize = 4; | ||
|
|
||
| /// Get a list of features to document at docs.rs in addition the default | ||
| pub fn docs_rs_features(tags: &[&Tag], default_feature: &str) -> Vec<String> { |
There was a problem hiding this comment.
What if there's no default, which I know is true for some services. Or, IIRC from your recent PR about this, is the default, by default, considered the first unless basic info declares an actual default?
There was a problem hiding this comment.
There may not be a default tag. The default feature takes that into account, see fn get_default_feature.
| @@ -21,7 +21,7 @@ azure_identity = { path = "../../../sdk/identity", version = "0.1" } | |||
| tokio = { version = "1.0", features = ["macros"] } | |||
|
|
|||
| [package.metadata.docs.rs] | |||
| all-features = true | |||
| features = [] | |||
There was a problem hiding this comment.
Doesn't this mean nothing gets documented? I'd expect this to be a subset of features.default <= 5 features. This might be a symptom of no default with which I was concerned above.
There was a problem hiding this comment.
The default feature gets documented.
There was a problem hiding this comment.
This can be tested with:
cargo doc -p azure_svc_schemaregistry --no-deps --open --features "no-default-version"
|
I've tested by passing the list of features to |
For #634, this limits the published API tags to 5, the default and 4 more.