Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Document From::from impls #137330

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

Open
TimTheBig wants to merge 22 commits into rust-lang:master
base: master
Choose a base branch
Loading
from TimTheBig:document-from
Open

Conversation

Copy link

@TimTheBig TimTheBig commented Feb 20, 2025

This resolves #51430 by documenting all from impls in lib std and core.
I still need someone to look over a few of the comments to see if the style is correct.

Copy link
Collaborator

rustbot commented Feb 20, 2025

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Amanieu (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbot rustbot added O-linux Operating system: Linux O-solid Operating System: SOLID O-unix Operating system: Unix-like O-windows Operating system: Windows S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Feb 20, 2025
Copy link
Collaborator

rustbot commented Feb 20, 2025

The Miri subtree was changed

cc @rust-lang/miri

Portable SIMD is developed in its own repository. If possible, consider making this change to rust-lang/portable-simd instead.

cc @calebzulawski, @programmerjake

rust-analyzer is developed in its own repository. If possible, consider making this change to rust-lang/rust-analyzer instead.

cc @rust-lang/rust-analyzer

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

@fmease fmease changed the title (削除) Document from (削除ここまで) (追記) Document From::from impls (追記ここまで) Feb 20, 2025
Copy link
Author

@rustbot label A-docs C-enhancement T-libs-api

@rustbot rustbot added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. labels Feb 20, 2025
Copy link
Author

TimTheBig commented Feb 20, 2025 •
edited
Loading

Should I move Portable SIMD and rust-analyzer changes even though they are small?

This comment has been minimized.

Copy link
Member

It is generally a good idea to split up large changes. :) You changed a whole bunch of files in rust-analyzer, so yeah that should be split. Miri and clippy have fewer changes, but the fact that there are any changes at all there still contradicts the PR description.

It's too late now, but the best strategy for PRs like this is to start with just a few files, e.g. just core, take the review feedback, and then apply that to the next PRs. That avoids having to re-do large amounts of work when there is overarching feedback.
TimTheBig reacted with thumbs up emoji

Copy link
Collaborator

rustbot commented Feb 20, 2025

The Miri subtree was changed

cc @rust-lang/miri

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

Portable SIMD is developed in its own repository. If possible, consider making this change to rust-lang/portable-simd instead.

cc @calebzulawski, @programmerjake

rust-analyzer is developed in its own repository. If possible, consider making this change to rust-lang/rust-analyzer instead.

cc @rust-lang/rust-analyzer

Copy link
Author

TimTheBig commented Feb 20, 2025 •
edited
Loading

My mistake, I will revert the rust-analyzer changes.

This comment has been minimized.

This comment has been minimized.

@rustbot rustbot added has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 20, 2025

This comment has been minimized.

@rustbot rustbot removed has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 20, 2025

This comment has been minimized.

Copy link
Contributor

@oli-obk oli-obk left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This PR requires a lot of changes, I did not get far with reviews, but a lot of the doc comments only explain the body in its rawest form. I feel like fully reviewing this just makes the reviewer do the work of documenting things, so it may be easier to just write PRs with documentation.

Also please disclose whether you generated this documentation, even just partially or as an initial thing that you edited.

Copy link
Contributor

@Sky9x Sky9x left a comment

Choose a reason for hiding this comment

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

Remove comments on:

  • Obvious/self explanatory conversions. These comments are redundant with the signature of the method.
  • Internal/private types. These do not need rustdocs.
  • Platform specific code. These do not need rustdocs.

workingjubilee reacted with heart emoji
@@ -728,6 +742,7 @@ impl ExitStatus {

/// Converts a raw `u32` to a type-safe `ExitStatus` by wrapping it without copying.
impl From<u32> for ExitStatus {
/// Wrap `u32` in a type-safe `ExitStatus`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Wrap `u32` in a type-safe `ExitStatus`

@@ -777,12 +792,14 @@ impl ExitCode {
}

impl From<u8> for ExitCode {
/// Convert the `u8` to a `u32` then wrap it in a `ExitCode`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Convert the `u8` to a `u32` then wrap it in a `ExitCode`

fn from(code: u8) -> Self {
ExitCode(u32::from(code))
}
}

impl From<u32> for ExitCode {
/// Wrap the `u32` in a `ExitCode`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Wrap the `u32` in a `ExitCode`

@@ -1265,6 +1265,7 @@ mod thread_name_string {
}

impl From<String> for ThreadNameString {
/// Convert `String` to a `CString` then use that as the `ThreadNameString` inner
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Convert `String` to a `CString` then use that as the `ThreadNameString` inner

Copy link
Author

@Sky9x Thank you for the suggestions.

@@ -636,6 +645,7 @@ impl From<Rc<[u8]>> for Rc<ByteStr> {
#[unstable(feature = "bstr", issue = "134915")]
#[cfg(not(no_rc))]
impl From<Rc<ByteStr>> for Rc<[u8]> {
/// Create a `Rc<ByteStr>` from the bytes of `Rc<[u8]>`.
Copy link
Author

@TimTheBig TimTheBig May 4, 2025

Choose a reason for hiding this comment

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

Suggested change
/// Create a `Rc<ByteStr>` from the bytes of `Rc<[u8]>`.
/// Unwrap the inner bytes of `Rc<ByteStr>`.

Copy link
Member

@Sky9x had several suggestions that were reasonable to act on but were not taken. I do not understand why they were skipped. I fear you are trying to use the GitHub UI for this entire process, making suggestions to yourself and then committing them. That is about to become very complicated for you... now. I cannot approve this without it being rebase-squashed.

@rustbot author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 4, 2025
Copy link
Collaborator

rustbot commented Jun 4, 2025

Reminder, once the PR becomes ready for a review, use @rustbot ready.

Copy link
Member

There may need to be changes even after that, but I don't think we'll successfully navigate the rest of this review if you insist on making every single change via a suggestion to yourself in the GitHub UI. I am sorry, it simply was not designed for use at the intensity you are giving it.

Copy link
Author

I have gain quite a bit of experience with PR's, I will rethink my strategy and stop using the GitHub UI. Thank you for the advice.
workingjubilee reacted with thumbs up emoji

Copy link
Collaborator

bors commented Jun 17, 2025

☔ The latest upstream changes (presumably #137944) made this pull request unmergeable. Please resolve the merge conflicts.

Copy link
Member

@TimTheBig any updates on this?

Copy link
Author

@TimTheBig any updates on this?

I'm very busy right now but I plan to finish this once I have some free time
Dylan-DPC reacted with thumbs up emoji

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blyxyas blyxyas blyxyas left review comments

@oli-obk oli-obk Awaiting requested review from oli-obk

@workingjubilee workingjubilee Awaiting requested review from workingjubilee

+2 more reviewers

@programmerjake programmerjake programmerjake left review comments

@Sky9x Sky9x Sky9x requested changes

Reviewers whose approvals may not affect merge requirements
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. O-linux Operating system: Linux O-solid Operating System: SOLID O-unix Operating system: Unix-like O-windows Operating system: Windows S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Many From implementations are undocumented

AltStyle によって変換されたページ (->オリジナル) /