API review: enable all features in the C++ docs #5592
Conversation
And make sure that functions excluded when freestanding is enabled are included in the docs.
| @@ -86,11 +86,11 @@ pub fn generate(show_warnings: bool) -> Result<(), Box<dyn std::error::Error>> { | |||
| let enabled_features = cbindgen::EnabledFeatures { | |||
There was a problem hiding this comment.
we could make a cbindgen::EnabledFeatures::all_true() constructor.
But no, because some of the features are still false.
xtask/src/cppdocs.rs
Outdated
| experimental: false, | ||
| system_testing: true, | ||
| freestanding: true, | ||
| experimental: true, |
There was a problem hiding this comment.
Maybe not experimental...
Right now that's only the test framework which is already documented anyway.
But if we add stuff as experimental, I'm not sure we want to have it in the docs. Or what do you think?
There was a problem hiding this comment.
I think it's a double edged sword. If we want feedback on an experiment, then we need to make it easy for people to opt into the experiment, so that they can use it and provide feedback (even feedback on the docs). On the other hand, yes, this gives the impression that this is an API ready for use. It won't work at compile-time, but it's in the docs.
I'll set it back to false for now.
There was a problem hiding this comment.
Right now that's only the test framework which is already documented anyway.
It's documented, but the documentation is not rendered as ... the experimental feature is false ;)
There was a problem hiding this comment.
Ah right, because #5398 hasn't been merged.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
And make sure that functions excluded when freestanding is enabled are included in the docs.