Skip to content

std: Mark ptr::Unique with #[doc(hidden)] - #49858

Merged
bors merged 2 commits into
rust-lang:masterfrom
tesaguri:unique-doc-hidden
Apr 27, 2018
Merged

std: Mark ptr::Unique with #[doc(hidden)]#49858
bors merged 2 commits into
rust-lang:masterfrom
tesaguri:unique-doc-hidden

Conversation

@tesaguri

@tesaguritesaguri commented Apr 10, 2018

Copy link
Copy Markdown
Contributor

Unique is now perma-unstable, so let's hide its docs.

@rust-highfive

rust-highfive commented Apr 10, 2018

Copy link
Copy Markdown
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @aidanhs (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 10, 2018
@ExpHP

ExpHP commented Apr 11, 2018

Copy link
Copy Markdown
Contributor

In what condition does this leave Box::into_unique? Does that still appear in docs?

@tesaguri

tesaguri commented Apr 11, 2018

Copy link
Copy Markdown
ContributorAuthor

Updated to hide Box::into_unique as well.

@clarfonthey

clarfonthey commented Apr 14, 2018

Copy link
Copy Markdown
Contributor

Wasn't this deprecated in favour of NonNull? Why does it need to be removed from docs?

@steveklabnik

steveklabnik commented Apr 16, 2018

Copy link
Copy Markdown
Contributor

@clarcharr for users, yes. the compiler still uses this, so we're not removing it. Nobody should use it though, so hiding it from the docs makes sense.

@steveklabniksteveklabnik added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Apr 16, 2018
@steveklabnik

steveklabnik commented Apr 16, 2018

Copy link
Copy Markdown
Contributor

I'd like to see what the rest of the docs team thinks about this.

@rfcbot: fcp merge

@rfcbot

rfcbot commented Apr 16, 2018•
edited by GuillaumeGomez
Loading

Copy link
Copy Markdown

Team member @steveklabnik has proposed to merge this. The next step is review by the rest of the tagged teams:

No concerns currently listed.

Once a majority of reviewers approve (and none object), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

@rfcbotrfcbot added the proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. label Apr 16, 2018
@QuietMisdreavus

QuietMisdreavus commented Apr 16, 2018

Copy link
Copy Markdown
Contributor

Is Box::into_unique the only other public API and returns or takes a Unique? A quick search on my local clone tells me that's it, but i could have overlooked something...

@rfcbot

rfcbot commented Apr 17, 2018

Copy link
Copy Markdown

🔔 This is now entering its final comment period, as per the review above. 🔔

@rfcbotrfcbot added final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. and removed proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. labels Apr 17, 2018
@emilyalbiniemilyalbini added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 23, 2018
@rfcbot

rfcbot commented Apr 27, 2018

Copy link
Copy Markdown

The final comment period is now complete.

@steveklabnik

steveklabnik commented Apr 27, 2018

Copy link
Copy Markdown
Contributor

Thanks @dmizuk!

@bors: r+ rollup

@bors

bors commented Apr 27, 2018

Copy link
Copy Markdown
Collaborator

📌 Commit 54d6bcb has been approved by steveklabnik

@borsbors 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 Apr 27, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Apr 27, 2018
@kennytm
Rollup merge ofrust-lang#49858- dmizuk:unique-doc-hidden, r=stevekl…
a18e7a6
…abnik
std: Mark `ptr::Unique` with `#[doc(hidden)]`
`Unique` is now perma-unstable, so let's hide its docs.
@kennytmkennytm mentioned this pull request Apr 27, 2018
Merged
bors added a commit that referenced this pull request Apr 27, 2018
@bors
Auto merge of#50290- kennytm:rollup, r=kennytm
686d0ae
Rollup of 9 pull requests
Successful merges:
- #49858 (std: Mark `ptr::Unique` with `#[doc(hidden)]`)
- #49968 (Stabilize dyn trait)
- #50192 (Add some utilities to `libsyntax`)
- #50251 (rustc: Disable threads in LLD for wasm)
- #50263 (rustc: Emit `uwtable` for allocator shims)
- #50269 (Update `parking_lot` dependencies)
- #50273 (Allow #[inline] on closures)
- #50284 (fix search load page failure)
- #50257 (Don't ICE on tuple struct ctor with incorrect arg count)
Failed merges:
@bors
bors merged commit 54d6bcb into rust-lang:masterApr 27, 2018
@AskaholicAskaholic mentioned this pull request Dec 20, 2018
Closed
This was referenced Apr 16, 2019
Closed
Closed
@lqdlqd mentioned this pull request Jul 17, 2019
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@frewsxcvfrewsxcvfrewsxcv approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@aidanhsaidanhs

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsfinal-comment-periodIn the final comment period and will be merged soon unless new substantive objections are raised.S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

11 participants

@tesaguri@rust-highfive@ExpHP@clarfonthey@steveklabnik@rfcbot@QuietMisdreavus@bors@frewsxcv@aidanhs@emilyalbini