rust-lang / rust-lang/reference

Imprecise language about function "access"

Open
#2,135 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-visibility
Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

vis.usage claims:

Accessing a module, for example, would mean looking inside of it (to import more items). On the other hand, accessing a function would mean that it is invoked.

I don't understand what this is supposed to mean, other than perhaps "usually, the reason you might want to access a function is to invoke it".

But of course while usually true that's not always true.

mod m1 {
    pub fn f() {}
}

fn main() {
    let p: fn() = m1::f;
    println!("{:?}", p);
}

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

Start at the vis.usage section of the Rust Reference and compare its explanation of function access with the provided function-pointer example. Done means the wording accurately distinguishes referring to a function from invoking it, without implying that access always causes invocation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.