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.

Sign up for GitHub

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

Jump to bottom

Use doc_cfg to render feature badges for feature-gated functionality #240

Merged
merged 1 commit into from
Nov 3, 2021
Merged

Use doc_cfg to render feature badges for feature-gated functionality #240

merged 1 commit into from
Nov 3, 2021

Conversation

brycx
Copy link
Member

@brycx brycx commented Oct 31, 2021

fixes #238

RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc --no-deps --all-features --open

Screenshots:
ss1
ss2
ss3
ss4

@brycx brycx added the documentation Issues and improvements sorrounding the documentation label Oct 31, 2021
@brycx brycx added this to the v0.16.1 milestone Oct 31, 2021
@brycx brycx requested a review from vlmutolo October 31, 2021 10:53
vlmutolo
vlmutolo approved these changes Nov 2, 2021
View reviewed changes
Copy link
Contributor

@vlmutolo vlmutolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's great 👍🏼. I was initially worried about seeing a bunch of safe_api badges everywhere, but you restricted it to module boundaries, so I think that works well. And anything that makes it clearer what features you have to use is a big win.

@brycx brycx merged commit b436fba into master Nov 3, 2021
@brycx brycx deleted the render-feature-badges branch November 3, 2021 08:33
brycx added a commit that referenced this pull request Nov 3, 2021
@brycx
doc: Add missing rendering of serde feature badges (see #240)
7951da1
brycx added a commit that referenced this pull request Nov 3, 2021
@brycx
0.16.1 (#247)
ae33cae 
* Bump version and add CHANGELOG entry

* doc: Add missing rendering of serde feature badges (see #240)

* Update 0.16.1 date TBD
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vlmutolo vlmutolo vlmutolo approved these changes

Assignees
No one assigned
Labels
documentation Issues and improvements sorrounding the documentation
Projects
None yet
Milestone
v0.16.1
Development

Successfully merging this pull request may close these issues.

Render feature badges for API on docs.rs
2 participants
@brycx @vlmutolo