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

Improve document of UnpinStruct #62

Merged
merged 1 commit into from
Sep 3, 2019
Merged

Improve document of UnpinStruct #62

merged 1 commit into from
Sep 3, 2019

Conversation

taiki-e
Copy link
Owner

@taiki-e taiki-e commented Sep 3, 2019

Improve document and add a way to opt-out mentioned in #53 (comment).

The reason for needing support for ways other than -Zallow-features is that it also affects the use of other dependency unstable features.

Related: #54 #56 (comment)

Generated document:

struct-1

struct-2

Ways to opt-out of this:

// You can opt-out of this in one of the followg ways:
// * Use `--cfg pin_project_stable_docs` in RUSTFLAGS.
// ```toml
// # in Cargo.toml
// [package.metadata.docs.rs]
// rustdoc-args = ["--cfg", "pin_project_stable_docs"]
// ```
// * Use `-Zallow-features` in RUSTFLAGS to disallow unstable features.

@taiki-e
Copy link
Owner Author

taiki-e commented Sep 3, 2019

cc @Aaron1011 @Nemo157 @LucioFranco

@taiki-e taiki-e added this to the v0.4 milestone Sep 3, 2019
@taiki-e
Copy link
Owner Author

taiki-e commented Sep 3, 2019

bors r=Aaron1011

bors bot added a commit that referenced this pull request Sep 3, 2019
62: Improve document of UnpinStruct r=Aaron1011 a=taiki-e

Improve document and add a way to opt-out mentioned in #53 (comment).

The reason for needing support for ways other than `-Zallow-features` is that it also affects the use of other dependency unstable features.

Related:  #54 #56 (comment)

Generated document:

<img width="1001" alt="struct-1" src="https://user-images.githubusercontent.com/43724913/64136451-95494280-ce2c-11e9-81ce-6a02c315332f.png">
<img width="1015" alt="struct-2" src="https://user-images.githubusercontent.com/43724913/64136462-a6924f00-ce2c-11e9-9d1c-3cdca2d9b158.png">

Ways to opt-out of this:

https://github.com/taiki-e/pin-project/blob/5f7c6e35c2a9f3dfbc01a63e6206875d1bfb986b/pin-project-internal/build.rs#L21-L28

Co-authored-by: Taiki Endo <te316e89@gmail.com>
@bors
Copy link
Contributor

bors bot commented Sep 3, 2019

Build succeeded

  • taiki-e.pin-project

@bors bors bot merged commit 5f7c6e3 into master Sep 3, 2019
@taiki-e taiki-e deleted the pin_project_stable_docs branch September 3, 2019 18:23
@taiki-e taiki-e mentioned this pull request Sep 4, 2019
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