Skip to content
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

Update doc for alloc::format! and core::concat! #115560

Merged
merged 1 commit into from
Sep 16, 2023

Conversation

ShE3py
Copy link
Contributor

@ShE3py ShE3py commented Sep 5, 2023

Closes #115551.

Used comments instead of assert!s as std::fmt uses comments.

Should all the str-related macros (format!, format_args!, concat!, stringify!, println!, writeln!, etc.) references each others? For instance, concat! mentions that integers are stringified, but don't link to stringify!.

@rustbot label +A-docs +A-fmt

@rustbot
Copy link
Collaborator

rustbot commented Sep 5, 2023

r? @joshtriplett

(rustbot has picked a reviewer for you, use r? to override)

@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. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-fmt Area: std::fmt labels Sep 5, 2023
@ShE3py ShE3py changed the title Add output comments to alloc::format! Update doc for alloc::format! and core::concat! Sep 6, 2023
@ShE3py ShE3py marked this pull request as ready for review September 6, 2023 13:58
Copy link
Member

@dtolnay dtolnay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@dtolnay
Copy link
Member

dtolnay commented Sep 16, 2023

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 16, 2023

📌 Commit 94e651b has been approved by dtolnay

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 16, 2023
@dtolnay dtolnay assigned dtolnay and unassigned joshtriplett Sep 16, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 16, 2023
…iaskrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#115247 (Document std limitations before/after main)
 - rust-lang#115329 (fix std::primitive doc: homogenous -> homogeneous)
 - rust-lang#115487 (Improve documentation on when signes are printed by default)
 - rust-lang#115560 (Update doc for `alloc::format!` and `core::concat!`)
 - rust-lang#115836 (update rust_analyzer_settings.json)
 - rust-lang#115884 (make ty::Const debug printing less verbose)
 - rust-lang#115890 (Migrate GUI colors test to original CSS color format)
 - rust-lang#115895 (Improve Vec(Deque)::truncate documentation)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 633f143 into rust-lang:master Sep 16, 2023
11 checks passed
@rustbot rustbot added this to the 1.74.0 milestone Sep 16, 2023
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Sep 16, 2023
Rollup merge of rust-lang#115560 - ShE3py:format-results, r=dtolnay

Update doc for `alloc::format!` and `core::concat!`

Closes rust-lang#115551.

Used comments instead of `assert!`s as [`std::fmt`](https://doc.rust-lang.org/std/fmt/index.html#usage) uses comments.

Should all the str-related macros (`format!`, `format_args!`, `concat!`, `stringify!`, `println!`, `writeln!`, etc.) references each others? For instance, [`concat!`](https://doc.rust-lang.org/core/macro.concat.html) mentions that integers are stringified, but don't link to `stringify!`.

`@rustbot` label +A-docs +A-fmt
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-fmt Area: std::fmt S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. 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.

Format Macro Named Argument Example is Confusing
5 participants