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

Added error documentation for write_fmt #105172

Merged
merged 1 commit into from
Jan 14, 2023
Merged

Added error documentation for write_fmt #105172

merged 1 commit into from
Jan 14, 2023

Conversation

alexs-sh
Copy link
Contributor

@alexs-sh alexs-sh commented Dec 2, 2022

This continuation of work at #98861

@rustbot
Copy link
Collaborator

rustbot commented Dec 2, 2022

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

Please see the contribution instructions for more information.

@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 Dec 2, 2022
@rustbot
Copy link
Collaborator

rustbot commented Dec 2, 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

@alexs-sh alexs-sh mentioned this pull request Dec 4, 2022
Closed
@clubby789
Copy link
Contributor

Since this just duplicates the error comment for std::fmt::Write::write_str, it might be better to add a 'See for details', so the comments don't get out of sync if they're updated in future.

@alexs-sh
Copy link
Contributor Author

alexs-sh commented Jan 2, 2023

Hi,@clubby789 Yes, I agree. It will be better. Thanks for your reply and your idea.

@alexs-sh
Copy link
Contributor Author

alexs-sh commented Jan 3, 2023

@clubby789 I added a link to std::fmt::Write::write_str error. Could you please review it?

@scottmcm
Copy link
Member

Looks good; thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jan 14, 2023

📌 Commit c466be0 has been approved by scottmcm

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 Jan 14, 2023
@JohnTitor JohnTitor mentioned this pull request Jan 14, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 14, 2023
@bors
Auto merge of rust-lang#106833 - JohnTitor:rollup-z8398jk, r=JohnTitor
c0b8735 
Rollup of 13 pull requests

Successful merges:

 - rust-lang#104965 (reword Option::as_ref and Option::map examples)
 - rust-lang#105172 (Added error documentation for write_fmt)
 - rust-lang#106605 (rustdoc: fix outdated lint section of the book)
 - rust-lang#106670 (Check compiler docs in PR CI)
 - rust-lang#106692 (mv binary_heap.rs binary_heap/mod.rs)
 - rust-lang#106693 (rustdoc: rename CSS rustdoc-toggle -> toggle and toggle -> settings-toggle)
 - rust-lang#106707 (Remove duplicate sha-1 dependency)
 - rust-lang#106762 (Add `AtomicPtr::as_mut_ptr`)
 - rust-lang#106766 (Remove dead code in rustdoc stripper)
 - rust-lang#106775 (Remove stale reference to the test suite location)
 - rust-lang#106799 (Stop having unused lifetimes on some `impl`s)
 - rust-lang#106816 (Update `rental` hack to work with remapped paths.)
 - rust-lang#106819 (rustdoc: remove unnecessary DOM class `h1.fqn`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 6d8ac83 into rust-lang:master Jan 14, 2023
@rustbot rustbot added this to the 1.68.0 milestone Jan 14, 2023
@alexs-sh alexs-sh deleted the issue-98861-fix-next branch January 14, 2023 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@scottmcm scottmcm

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.68.0
Development

Successfully merging this pull request may close these issues.
5 participants
@alexs-sh @rustbot @clubby789 @scottmcm @bors