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

Properly inline documentation and use intra-crate lints #98

Merged
merged 1 commit into from Sep 30, 2019

Conversation

Aaron1011
Copy link
Collaborator

Now that rust-lang/rust#64536 has landed, all of the bugs with proc
macro documentation have now been fixed (currently only on the latest
nightly). We can now use #[doc(inline)] on proc macro imports, which
works just like any other import.

@Aaron1011
Copy link
Collaborator Author

Note that docs.rs is currently using an older version of rust, which might not properly build this. This should be fixed after September 30th when docs.rs switches to always using the latest nightly.

Copy link
Owner

@taiki-e taiki-e left a comment

Choose a reason for hiding this comment

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

Thank you for fixing these issues. I'm going to merge this when docs.rs is updated.

@taiki-e taiki-e mentioned this pull request Sep 20, 2019
11 tasks
@taiki-e taiki-e added C-documentation Category: related to documentation. S-blocked Status: Blocked on something else labels Sep 24, 2019
Now that rust-lang/rust#64536 has landed, all of the bugs with proc
macro documentation have now been fixed (currently only on the latest
nightly). We can now use `#[doc(inline)]` on proc macro imports, which
works just like any other import.
@Aaron1011
Copy link
Collaborator Author

@taiki-e: The docs.rs changes have been applied, so this PR should be ready to merge

@Aaron1011 Aaron1011 removed the S-blocked Status: Blocked on something else label Sep 30, 2019
@taiki-e
Copy link
Owner

taiki-e commented Sep 30, 2019

Thanks again!

bors r+

bors bot added a commit that referenced this pull request Sep 30, 2019
98: Properly inline documentation and use intra-crate lints r=taiki-e a=Aaron1011

Now that rust-lang/rust#64536 has landed, all of the bugs with proc
macro documentation have now been fixed (currently only on the latest
nightly). We can now use `#[doc(inline)]` on proc macro imports, which
works just like any other import.

Co-authored-by: Aaron Hill <aa1ronham@gmail.com>
@bors
Copy link
Contributor

bors bot commented Sep 30, 2019

Build succeeded

  • taiki-e.pin-project

@bors bors bot merged commit 9f4dcb5 into taiki-e:master Sep 30, 2019
bors bot added a commit that referenced this pull request Oct 12, 2019
126: Remove outdated TODO comments r=taiki-e a=taiki-e

This issue has been fixed in #98.

Co-authored-by: Taiki Endo <te316e89@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-documentation Category: related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants