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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 2 commits into from
Apr 27, 2018
Merged

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

merged 2 commits into from
Apr 27, 2018

Conversation

tesaguri
Copy link
Contributor

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

@rust-highfive
Copy link
Collaborator

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-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 10, 2018
@ExpHP
Copy link
Contributor

ExpHP commented Apr 11, 2018

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

@tesaguri
Copy link
Contributor Author

Updated to hide Box::into_unique as well.

@clarfonthey
Copy link
Contributor

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

@steveklabnik
Copy link
Member

@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.

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

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

@rfcbot: fcp merge

@rfcbot
Copy link

rfcbot commented Apr 16, 2018 •
edited by GuillaumeGomez
Loading

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.

@rfcbot rfcbot 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
Copy link
Member

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
Copy link

rfcbot commented Apr 17, 2018

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

@rfcbot rfcbot 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
@pietroalbini pietroalbini 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
Copy link

rfcbot commented Apr 27, 2018

The final comment period is now complete.

@steveklabnik
Copy link
Member

Thanks @dmizuk!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Apr 27, 2018

📌 Commit 54d6bcb has been approved by steveklabnik

@bors 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 Apr 27, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Apr 27, 2018
@kennytm
Rollup merge of rust-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.
@kennytm kennytm 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:master Apr 27, 2018
@Askaholic Askaholic mentioned this pull request Dec 20, 2018
Closed
This was referenced Apr 16, 2019
Closed
Closed
@lqd lqd mentioned this pull request Jul 17, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frewsxcv frewsxcv frewsxcv approved these changes

Assignees

@aidanhs aidanhs

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. S-waiting-on-bors Status: 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.