tisonkun commented on code in PR #13: URL: https://github.com/apache/datasketches-rust/pull/13#discussion_r2618721266
########## src/lib.rs: ########## @@ -23,6 +23,7 @@ //! //! This library is divided into modules that constitute distinct groups of functionality. +#![cfg_attr(docsrs, feature(doc_cfg))] Review Comment: We don't have feature flags yet, but it's good to align with what docs.rs processes our docs. Now, locally we can test it out with: ```rust RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps --open ``` See https://users.rust-lang.org/t/how-to-document-optional-features-in-api-docs/64577/3 provides the information. We may add this cfg_attr when we have feature flags but this is a good preset so we don't need to care about it from now on :D And I think we will add some feature flags at some point, like opt-support for serde, opt-in some perf instructions, etc. ########## src/lib.rs: ########## @@ -23,6 +23,7 @@ //! //! This library is divided into modules that constitute distinct groups of functionality. +#![cfg_attr(docsrs, feature(doc_cfg))] Review Comment: We don't have feature flags yet, but it's good to align with what docs.rs processes our docs. Now, locally we can test it out with: ```sh RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps --open ``` See https://users.rust-lang.org/t/how-to-document-optional-features-in-api-docs/64577/3 provides the information. We may add this cfg_attr when we have feature flags but this is a good preset so we don't need to care about it from now on :D And I think we will add some feature flags at some point, like opt-support for serde, opt-in some perf instructions, etc. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
