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

Do not display UnpinStruct in the document by default #71

Merged
merged 2 commits into from
Sep 4, 2019
Merged

Conversation

taiki-e
Copy link
Owner

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

There are some problems as mentioned in #70

This causes the problem that by default the actual Unpin bounds cannot be known from the document if the original struct/enum itself is public (see #53 (comment) and rust-lang/rust#63281 for more).

This can be enabled using --cfg pin_project_show_unpin_struct in RUSTFLAGS.

# in Cargo.toml
[package.metadata.docs.rs]
rustdoc-args = ["--cfg", "pin_project_show_unpin_struct"]

cc @Aaron1011 @seanmonstar @LucioFranco

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

taiki-e commented Sep 4, 2019

bors r+

bors bot added a commit that referenced this pull request Sep 4, 2019
71: Do not display UnpinStruct in the document by default r=taiki-e a=taiki-e

There are some problems as mentioned in #70 

This causes the problem that by default the actual Unpin bounds cannot be known from the document if the original struct/enum itself is public (see #53 (comment) and rust-lang/rust#63281 for more).

This can be enabled using `--cfg pin_project_show_unpin_struct` in RUSTFLAGS.

```toml
# in Cargo.toml
[package.metadata.docs.rs]
rustdoc-args = ["--cfg", "pin_project_show_unpin_struct"]
```

cc @Aaron1011 @seanmonstar @LucioFranco

Co-authored-by: Taiki Endo <te316e89@gmail.com>
@@ -49,7 +49,7 @@ jobs:
toolchain: nightly
- script: |
cargo clean
RUSTFLAGS='--cfg compiletest' cargo test -p pin-project --all-features --test compiletest
RUSTFLAGS='--cfg compiletest --cfg pin_project_show_unpin_struct' cargo test -p pin-project --all-features --test compiletest
Copy link
Owner Author

Choose a reason for hiding this comment

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

cc #35 It becomes even more complicated :(

@bors
Copy link
Contributor

bors bot commented Sep 4, 2019

Build succeeded

  • taiki-e.pin-project

@bors bors bot merged commit 60751fb into master Sep 4, 2019
@taiki-e taiki-e deleted the docs-2 branch September 4, 2019 21:27
@taiki-e taiki-e added the A-pin-projection Area: #[pin_project] label Jun 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-pin-projection Area: #[pin_project]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants