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 all feature, and show feature requirements #98

Merged
merged 1 commit into from
May 16, 2022

Conversation

michaelkirk
Copy link
Member

@michaelkirk michaelkirk commented May 4, 2022

  • I agree to follow the project's code of conduct.
  • I added an entry to CHANGES.md if knowledge of this change could be valuable to users.
  • I ran cargo fmt

This is similar to what we do in geojson and elsewhere. Though I just learned about doc_auto_cfg which makes this way easier by automatically annotating any required items, rather than needing to try to sprinkle a bunch of calls all over like:

#[cfg_attr(docsrs, doc(cfg(feature = "geo-types")))]
mod my_geo_types_module;

e.g.
Screen Shot 2022-05-04 at 3 19 26 PM

This is similar to what we do in geojson and elsewhere. Though I just
learned about doc_auto_cfg which makes this way easier by automatically
annotating any required items, rather than needing to try to sprinkle a
bunch of calls all over like:

    #[cfg_attr(docsrs, doc(cfg(feature = "geo-types")))]
    mod my_geo_types_module;
@michaelkirk michaelkirk force-pushed the mkirk/docs-features branch from 9981892 to 0ccb840 Compare May 4, 2022 22:02
@michaelkirk michaelkirk requested a review from frewsxcv May 13, 2022 22:40
@michaelkirk
Copy link
Member Author

bors r=frewsxcv

@bors
Copy link
Contributor

bors bot commented May 16, 2022

Build succeeded:

@bors bors bot merged commit b0965a3 into main May 16, 2022
@bors bors bot deleted the mkirk/docs-features branch May 16, 2022 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants