Skip to content

core::ptr: deduplicate more method docs #142101

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
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

lolbinarycat
Copy link
Contributor

@lolbinarycat lolbinarycat commented Jun 6, 2025

used rg -Fxf library/core/src/ptr/{const,mut}_ptr.rs to find duplicated doc comments, and diff -u after copying them to files to ensure they are actually identical.

sed 's| */// *||' was then used to translate the doc comments to plain markdown.

part of #139190

@rustbot

This comment was marked as resolved.

@rustbot rustbot added 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 Jun 6, 2025
@lolbinarycat

This comment was marked as off-topic.

@rustbot rustbot assigned workingjubilee and unassigned jieyouxu Jun 6, 2025
@rust-log-analyzer
Copy link
Collaborator

The job mingw-check-2 failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)
[RUSTC-TIMING] build_script_build test:false 0.389
error: unresolved link to `as_uninit_slice_mut`
    --> library/core/src/ptr/mut_ptr.rs:1895:43
     |
1895 |     /// For the mutable counterpart see [`as_uninit_slice_mut`].
     |                                           ^^^^^^^^^^^^^^^^^^^ no item named `as_uninit_slice_mut` in scope
     |
     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
     = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
     = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`

error: could not document `core`
warning: build failed, waiting for other jobs to finish...
[RUSTC-TIMING] core test:false 31.434
Command has failed. Rerun with -v to see more details.
Build completed unsuccessfully in 0:00:34
  local time: Fri Jun  6 01:31:19 UTC 2025
  network time: Fri, 06 Jun 2025 01:31:19 GMT
##[error]Process completed with exit code 1.
Post job cleanup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants