rust-lang / rust-lang/reference
Imprecise language about function "access"
Nobody has claimed this yet.
- 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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