Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document features #798

Open
fenhl opened this issue Sep 13, 2021 · 3 comments
Open

Document features #798

fenhl opened this issue Sep 13, 2021 · 3 comments
Labels

Comments

@fenhl
Copy link

fenhl commented Sep 13, 2021

There are some cargo features that appear to modify the behavior of the crate, but it is not clear what exactly they do. It would be useful to have an overview of the following features in the crate-level docs:

  • preserve_order
  • raw_value
  • unbounded_depth
  • arbitrary_precision
  • float_roundtrip
@jpmckinney
Copy link

I found docs in https://github.com/serde-rs/json/blob/master/Cargo.toml but these can be made easier to find :)

@dtolnay dtolnay added the docs label Jan 22, 2022
@kangalio
Copy link

Perhaps the docs could point to the Cargo.toml? The Cargo.toml contains the ground truth - the feature names, the inter-feature dependencies, and the feature docs, all in one place. If that information was mirrored in another place, every feature change would need to be updated in two places and there would be a high risk of drifting out of sync

(I wish rustdoc could extract doc comments on features inside Cargo.toml)

@jayvdb
Copy link

jayvdb commented Jun 28, 2023

https://docs.rs/document-features/latest/document_features/ can extract comments from Cargo.toml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

5 participants