Merge #126

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>

pin-project-internal/src/lib.rs

@@ -38,7 +38,6 @@ use syn::parse::Nothing;
 
 use utils::{Immutable, Mutable};
 
-// TODO: Move this doc into pin-project crate when https://github.com/rust-lang/rust/pull/62855 merged.
 /// An attribute that creates a projection struct covering all the fields.
 ///
 /// This attribute creates a projection struct according to the following rules:
@@ -335,7 +334,6 @@ pub fn pin_project(args: TokenStream, input: TokenStream) -> TokenStream {
     pin_project::attribute(args.into(), input).into()
 }
 
-// TODO: Move this doc into pin-project crate when https://github.com/rust-lang/rust/pull/62855 merged.
 /// An attribute for annotating an impl block that implements [`Drop`].
 ///
 /// This attribute is only needed when you wish to provide a [`Drop`]
@@ -378,7 +376,6 @@ pub fn pinned_drop(args: TokenStream, input: TokenStream) -> TokenStream {
     pinned_drop::attribute(input).into()
 }
 
-// TODO: Move this doc into pin-project crate when https://github.com/rust-lang/rust/pull/62855 merged.
 /// An attribute to provide way to refer to the projected type returned by
 /// `project` method.
 ///

src/lib.rs

@@ -1,11 +1,5 @@
 //! A crate for safe and ergonomic pin-projection.
 //!
-//! This crate provides the following attribute macros:
-//!
-//! * [`pin_project`] - An attribute that creates a projection struct covering all the fields.
-//! * [`pinned_drop`] - An attribute for annotating a function that implements `Drop`.
-//! * [`project`] - An attribute to support pattern matching.
-//!
 //! ## Examples
 //!
 //! [`pin_project`] attribute creates a projection struct covering all the fields.
@@ -32,11 +26,11 @@
 //!
 //! [Code like this will be generated](https://github.com/taiki-e/pin-project/blob/master/examples/struct-default-expanded.rs)
 //!
-//! There are examples and generated code of each feature in [examples](https://github.com/taiki-e/pin-project/blob/master/examples/README.md) directory.
+//! See [`pin_project`] attribute for more details.
+//!
+//! Also, there are examples and generated code of each feature in [examples](https://github.com/taiki-e/pin-project/blob/master/examples/README.md) directory.
 //!
 //! [`pin_project`]: attr.pin_project.html
-//! [`pinned_drop`]: attr.pinned_drop.html
-//! [`project`]: attr.project.html
 
 #![no_std]
 #![recursion_limit = "256"]