Skip to content

Ambiguous documentation of line!() and column!() #46997

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.

Sign up for GitHub

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

Jump to bottom
Closed
dtolnay opened this issue Dec 25, 2017 · 1 comment
Closed

Ambiguous documentation of line!() and column!() #46997

dtolnay opened this issue Dec 25, 2017 · 1 comment
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.

Comments

@dtolnay
Copy link
Member

dtolnay commented Dec 25, 2017

The documentation of the line!() and column!() macros says:

The returned line is not the invocation of the `line!()` macro itself, but rather the first macro invocation leading up to the invocation of the `line!()` macro.

I find "not the invocation of the `line!` macro itself" a bit misleading, because it is totally possible and expected for the return value to be the line of the invocation of the line macro itself when not being called from another macro. It may be clearer as "not necessarily the line of the `line!` invocation itself".
@dtolnay dtolnay added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Dec 25, 2017
@gsollazzo gsollazzo added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Feb 1, 2018
@Manishearth Manishearth removed the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Feb 10, 2018
Songbird0 added a commit to Songbird0/rust that referenced this issue Mar 8, 2018
@Songbird0
Modify part of line! documentation.
2d7472f 
In accordance with rust-lang#46997, I've replaced:

> The returned line is not the invocation of the line! macro itself [...]

By

> The returned line is *not necessarily* the line of the `line!` invocation itself [...]
Songbird0 added a commit to Songbird0/rust that referenced this issue Mar 8, 2018
@Songbird0
Modify part of column! documentation.
a0758cd 
Just like `line!` documentation, I've replaced:

> The returned column is not the invocation of the `column!` macro itself

By

> The returned column is *not necessarily* the line of the `column!` invocation itself

See rust-lang#46997.
This was referenced Mar 8, 2018
Merged
Merged
Manishearth added a commit to Manishearth/rust that referenced this issue Mar 9, 2018
@Manishearth
Rollup merge of rust-lang#48856 - Songbird0:improve_line_macro_docume…
5ab4855 
…ntation, r=joshtriplett

Modify part of `line!` documentation.

In accordance with rust-lang#46997, I've replaced:

> The returned line is not the invocation of the line! macro itself [...]

By

> The returned line is *not necessarily* the line of the `line!` invocation itself [...]
Manishearth added a commit to Manishearth/rust that referenced this issue Mar 9, 2018
@Manishearth
Rollup merge of rust-lang#48857 - Songbird0:improve_column_macro_docu…
b65b171 
…mentation, r=joshtriplett

Modify part of `column!` documentation.

Just like `line!` documentation, I've replaced:

> The returned column is not the invocation of the `column!` macro itself

By

> The returned column is *not necessarily* the line of the `column!` invocation itself

See rust-lang#46997.
@steveklabnik
Copy link
Member

This has been fixed.

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

No branches or pull requests
4 participants
@steveklabnik @Manishearth @dtolnay @gsollazzo