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.

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

Reword the docstring in todo! macro definition, fixing a typo #110104

Merged
merged 2 commits into from
Apr 12, 2023
Merged

Reword the docstring in todo! macro definition, fixing a typo #110104

merged 2 commits into from
Apr 12, 2023

Conversation

kormosi
Copy link

@kormosi kormosi commented Apr 9, 2023

No description provided.

@rustbot
Copy link
Collaborator

rustbot commented Apr 9, 2023

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @cuviper (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@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. labels Apr 9, 2023
@rustbot
Copy link
Collaborator

rustbot commented Apr 9, 2023

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

cuviper
cuviper reviewed Apr 11, 2023
View reviewed changes
library/core/src/macros/mod.rs Outdated
Comment on lines 715 to 716
/// This can be useful if you are prototyping and are just looking to have your
/// code typecheck.
/// code typechecked.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should avoid that jargon altogether? Something like:

This can be useful if you are prototyping and just want a placeholder to let your code pass type analysis.

Copy link
Author

Choose a reason for hiding this comment

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

There's no reason for me not to use your words verbatim. Updating the PR.

@kormosi kormosi changed the title Fix typo in todo! macro docstring Reword the docstring in todo! macro definition, fixing a typo Apr 11, 2023
@cuviper
Copy link
Member

cuviper commented Apr 11, 2023

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 11, 2023

📌 Commit 4e84d69 has been approved by cuviper

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 Apr 11, 2023
@compiler-errors compiler-errors mentioned this pull request Apr 12, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 12, 2023
@bors
Auto merge of rust-lang#110214 - compiler-errors:rollup-mkig4t6, r=co…
0d7ed3b 
…mpiler-errors

Rollup of 10 pull requests

Successful merges:

 - rust-lang#96971 (Initial support for loongarch64-unknown-linux-gnu)
 - rust-lang#109894 (Remove Errors section from var_os docs)
 - rust-lang#110000 (Rename tests/ui/unique to tests/ui/box/unit)
 - rust-lang#110018 (Pass host linker to compiletest.)
 - rust-lang#110104 ( Reword the docstring in todo! macro definition, fixing a typo)
 - rust-lang#110113 (Fix `x test ui --target foo` when download-rustc is enabled)
 - rust-lang#110126 (Support safe transmute in new solver)
 - rust-lang#110155 (Fix typos in librustdoc, tools and config files)
 - rust-lang#110162 (rustdoc: remove redundant expandSection code from main.js)
 - rust-lang#110173 (kmc-solid: Implement `Socket::read_buf`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 4f2f7fd into rust-lang:master Apr 12, 2023
@rustbot rustbot added this to the 1.70.0 milestone Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cuviper cuviper cuviper left review comments

Assignees

@cuviper cuviper

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
Milestone
1.70.0
Development

Successfully merging this pull request may close these issues.
4 participants
@kormosi @rustbot @cuviper @bors