Add example to IsTerminal::is_terminal #124992

foresterre · 2024-05-10T23:51:01Z

No description provided.

rustbot · 2024-05-10T23:51:08Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ChrisDenton (or someone else) some time within the next two weeks.

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

ChrisDenton

This looks good. I'm fine with it as-is but there are a couple of things which I think might make it better.

ChrisDenton · 2024-05-19T15:09:46Z

library/std/src/io/stdio.rs

@@ -1161,7 +1161,39 @@ pub trait IsTerminal: crate::sealed::Sealed {
    /// starting with `msys-` or `cygwin-` and ending in `-pty` will be considered terminals.
    /// Note that this [may change in the future][changes].
    ///
+    /// # Examples
+    ///
+    /// An example of a type for which `IsTerminal` is implemented is [`Stdin`]:


It'd be great, though not essential, to have an example that includes both Stdin and Stdout.

library/std/src/io/stdio.rs

ChrisDenton · 2024-05-19T19:01:07Z

Thanks!

@bors r+ rollup

bors · 2024-05-19T19:01:10Z

📌 Commit 0b6baf6 has been approved by ChrisDenton

It is now in the queue for this repository.

…iaskrgr Rollup of 4 pull requests Successful merges: - rust-lang#124948 (chore: Remove repeated words (extension of rust-lang#124924)) - rust-lang#124992 (Add example to IsTerminal::is_terminal) - rust-lang#125279 (make `Debug` impl for `Term` simpler) - rust-lang#125286 (Miri subtree update) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#124992 - foresterre:example/is-terminal, r=ChrisDenton Add example to IsTerminal::is_terminal

…iaskrgr Rollup of 4 pull requests Successful merges: - rust-lang#124948 (chore: Remove repeated words (extension of rust-lang#124924)) - rust-lang#124992 (Add example to IsTerminal::is_terminal) - rust-lang#125279 (make `Debug` impl for `Term` simpler) - rust-lang#125286 (Miri subtree update) r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned ChrisDenton May 10, 2024

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 May 10, 2024