rust-lang / rust-lang/rust

Don't use *move* in `Pin` documentaton

Open
#123,135 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-docs C-enhancement T-libs
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

Location

https://doc.rust-lang.org/std/pin/index.html#what-is-moving

Summary

As explained there move usually has a different meaning in Rust. I suggest using another word to avoid this confusion.
We could use

  • Displace
  • Transfer
  • Relocate

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Pin documentation at the “What is moving” section and read the surrounding explanation of move terminology. Replace the ambiguous use of “move” with an agreed alternative such as “displace,” “transfer,” or “relocate,” while preserving the intended meaning. Done means the section no longer risks confusion with Rust’s move semantics.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.