Restore RawVec::reserve* documentation by glandium · Pull Request #50591 · rust-lang/rust (original) (raw)

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 andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation4 Commits1 Checks0 Files changed

Conversation

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters

[ Show hidden characters]({{ revealButtonHref }})

When the RawVec::try_reserve* methods were added, they took the place of
the ::reserve* methods in the source file, and new ::reserve* methods
wrapping the new try_reserve* methods were created. But the
documentation didn't move along, such that:

• reserve_* methods are barely documented.
• try_reserve_* methods have unmodified documentation from reserve_*,
  such that their documentation indicate they are panicking/aborting.

This moves the documentation back to the right methods, with a
placeholder documentation for the try_reserve* methods.

When the RawVec::try_reserve* methods were added, they took the place of the ::reserve* methods in the source file, and new ::reserve* methods wrapping the new try_reserve* methods were created. But the documentation didn't move along, such that:

• reserve_* methods are barely documented.
• try_reserve_* methods have unmodified documentation from reserve_*, such that their documentation indicate they are panicking/aborting.

This moves the documentation back to the right methods, with a placeholder documentation for the try_reserve* methods.

r? @dtolnay

(rust_highfive has picked a reviewer for you, use r? to override)

Choose a reason for hiding this comment

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

Thanks!

📌 Commit 9c4e5b3 has been approved by dtolnay

bors added S-waiting-on-bors

Status: Waiting on bors to run and complete tests. Bors will change the label on completion.

and removed S-waiting-on-review

Status: Awaiting review from the assignee but also interested parties.

labels

May 10, 2018

alexcrichton added a commit to alexcrichton/rust that referenced this pull request

May 10, 2018

Restore RawVec::reserve* documentation

When the RawVec::try_reserve* methods were added, they took the place of the ::reserve* methods in the source file, and new ::reserve* methods wrapping the new try_reserve* methods were created. But the documentation didn't move along, such that:

• reserve_* methods are barely documented.
• try_reserve_* methods have unmodified documentation from reserve_*, such that their documentation indicate they are panicking/aborting.

This moves the documentation back to the right methods, with a placeholder documentation for the try_reserve* methods.

alexcrichton added a commit to alexcrichton/rust that referenced this pull request

May 10, 2018

Restore RawVec::reserve* documentation

When the RawVec::try_reserve* methods were added, they took the place of the ::reserve* methods in the source file, and new ::reserve* methods wrapping the new try_reserve* methods were created. But the documentation didn't move along, such that:

• reserve_* methods are barely documented.
• try_reserve_* methods have unmodified documentation from reserve_*, such that their documentation indicate they are panicking/aborting.

This moves the documentation back to the right methods, with a placeholder documentation for the try_reserve* methods.

bors added a commit that referenced this pull request

May 10, 2018

Rollup of 18 pull requests

Successful merges:

• #49423 (Extend tests for RFC1598 (GAT))
• #50010 (Give SliceIndex impls a test suite of girth befitting the implementation (and fix a UTF8 boundary check))
• #50447 (Fix update-references for tests within subdirectories.)
• #50514 (Pull in a wasm fix from LLVM upstream)
• #50524 (Make DepGraph::previous_work_products immutable)
• #50532 (Don't use Lock for heavily accessed CrateMetadata::cnum_map.)
• #50538 ( Make CrateNum allocation more thread-safe. )
• #50564 (Inline Span methods.)
• #50565 (Use SmallVec for DepNodeIndex within dep_graph.)
• #50569 (Allow for specifying a linker plugin for cross-language LTO)
• #50572 (Clarify in the docs that mul_add is not always faster.)
• #50574 (add fn into_inner(self) -> (Idx, Idx) to RangeInclusive (#49022))
• #50575 (std: Avoid ptr::copy if unnecessary in vec::Drain)
• #50588 (Move "See also" disambiguation links for primitive types to top)
• #50590 (Fix tuple struct field spans)
• #50591 (Restore RawVec::reserve* documentation)
• #50598 (Remove unnecessary mutable borrow and resizing in DepGraph::serialize)
• #50606 (Retry when downloading the Docker cache.)

Failed merges:

• #50161 (added missing implementation hint)
• #50558 (Remove all reference to DepGraph::work_products)

Labels

S-waiting-on-bors

Status: Waiting on bors to run and complete tests. Bors will change the label on completion.