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

Extra documentation for new formatting feature #100855

Merged
merged 1 commit into from
Aug 24, 2022
Merged

Extra documentation for new formatting feature #100855

merged 1 commit into from
Aug 24, 2022

Conversation

IsaacCloos
Copy link
Contributor

Documentation of this feature was added in #90473 and released in Rust 1.58. However, high traffic macros did not receive new examples. Namely println!() and format!().

The doc comments included in Rust are super important to the community- especially newcomers. I have met several other newbies like myself who are unaware of this recent (well about 7 months old now) update to the language allowing for convenient intra-string identifiers.

Bringing small examples of this feature to the doc comments of println!() and format!() would be helpful to everyone learning the language.

Blog Post Announcing Feature
Feature PR - includes several instances of documentation of the feature- minus the macros in question for this PR

This is my first time contributing to a project this large. Feedback would mean the world to me 😄


Recreated; I violated the No-Merge Policy

High traffic macros should detail this helpful addition.
@rustbot rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Aug 21, 2022
@rustbot
Copy link
Collaborator

rustbot commented Aug 21, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@Xiretza
Copy link
Contributor

Xiretza commented Aug 22, 2022

Looks like @rust-highfive skipped over this PR for some reason - let's try this:

r? rust-lang/libs

It might be that only the PR author can do it, so if that doesn't do anything, please try posting the above line as a comment yourself.

Edit: yep, please try it yourself.

@IsaacCloos
Copy link
Contributor Author

r? rust-lang/libs

@joshtriplett
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Aug 23, 2022

📌 Commit acca4b8 has been approved by joshtriplett

It is now in the queue for this repository.

@bors bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Aug 23, 2022
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Aug 23, 2022
Extra documentation for new formatting feature

Documentation of this feature was added in rust-lang#90473 and released in Rust 1.58. However, high traffic macros did not receive new examples. Namely `println!()` and `format!()`.

The doc comments included in Rust are super important to the community- especially newcomers. I have met several other newbies like myself who are unaware of this recent (well about 7 months old now) update to the language allowing for convenient intra-string identifiers.

Bringing small examples of this feature to the doc comments of `println!()` and `format!()` would be helpful to everyone learning the language.

[Blog Post Announcing Feature](https://blog.rust-lang.org/2022/01/13/Rust-1.58.0.html)
[Feature PR](rust-lang#90473) - includes several instances of documentation of the feature- minus the macros in question for this PR

*This is my first time contributing to a project this large. Feedback would mean the world to me 😄*

---

*Recreated; I violated the [No-Merge Policy](https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy)*
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Aug 24, 2022
Extra documentation for new formatting feature

Documentation of this feature was added in rust-lang#90473 and released in Rust 1.58. However, high traffic macros did not receive new examples. Namely `println!()` and `format!()`.

The doc comments included in Rust are super important to the community- especially newcomers. I have met several other newbies like myself who are unaware of this recent (well about 7 months old now) update to the language allowing for convenient intra-string identifiers.

Bringing small examples of this feature to the doc comments of `println!()` and `format!()` would be helpful to everyone learning the language.

[Blog Post Announcing Feature](https://blog.rust-lang.org/2022/01/13/Rust-1.58.0.html)
[Feature PR](rust-lang#90473) - includes several instances of documentation of the feature- minus the macros in question for this PR

*This is my first time contributing to a project this large. Feedback would mean the world to me 😄*

---

*Recreated; I violated the [No-Merge Policy](https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy)*
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 24, 2022
Extra documentation for new formatting feature

Documentation of this feature was added in rust-lang#90473 and released in Rust 1.58. However, high traffic macros did not receive new examples. Namely `println!()` and `format!()`.

The doc comments included in Rust are super important to the community- especially newcomers. I have met several other newbies like myself who are unaware of this recent (well about 7 months old now) update to the language allowing for convenient intra-string identifiers.

Bringing small examples of this feature to the doc comments of `println!()` and `format!()` would be helpful to everyone learning the language.

[Blog Post Announcing Feature](https://blog.rust-lang.org/2022/01/13/Rust-1.58.0.html)
[Feature PR](rust-lang#90473) - includes several instances of documentation of the feature- minus the macros in question for this PR

*This is my first time contributing to a project this large. Feedback would mean the world to me 😄*

---

*Recreated; I violated the [No-Merge Policy](https://rustc-dev-guide.rust-lang.org/git.html#no-merge-policy)*
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 24, 2022
…iaskrgr

Rollup of 15 pull requests

Successful merges:

 - rust-lang#99993 (linker: Update some outdated comments)
 - rust-lang#100220 (Properly forward `ByRefSized::fold` to the inner iterator)
 - rust-lang#100826 (sugg: take into count the debug formatting)
 - rust-lang#100855 (Extra documentation for new formatting feature)
 - rust-lang#100888 (Coherence negative impls implied bounds)
 - rust-lang#100901 (Make some methods private)
 - rust-lang#100906 (Suggest alternatives when trying to mutate a `HashMap`/`BTreeMap` via indexing)
 - rust-lang#100912 (Diagnose missing includes in run-make tests)
 - rust-lang#100919 (Use par_body_owners for liveness)
 - rust-lang#100922 (Rewrite error index generator to greatly reduce the size of the pages)
 - rust-lang#100926 (Update README.md)
 - rust-lang#100930 (Use `--userns=keep-id` when "docker" is really podman)
 - rust-lang#100938 (rustdoc: remove unused CSS rule)
 - rust-lang#100940 (Do not suggest adding a bound to a opaque type)
 - rust-lang#100945 (Add a missing test case for impl generic mismatch)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit e802df9 into rust-lang:master Aug 24, 2022
@rustbot rustbot added this to the 1.65.0 milestone Aug 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

None yet

6 participants