Skip to content

Document - stdin convention in CLI help text#22817

Merged
ntBre merged 1 commit intomainfrom
brent/document-stdin
Jan 23, 2026
Merged

Document - stdin convention in CLI help text#22817
ntBre merged 1 commit intomainfrom
brent/document-stdin

Conversation

@ntBre
Copy link
Contributor

@ntBre ntBre commented Jan 22, 2026

Summary

While responding to #13690 (comment), I realized that the - convention for reading from stdin wasn't mentioned in
our CLI help anywhere. I thought it made sense to add a brief note to the FILES
help section, but I'm happy to put it somewhere else or rephrase it if someone
has a better suggestion!

Test Plan

Updated CLI tests

Summary
--

While responding to
#13690 (comment),
I realized that the `-` convention for reading from stdin wasn't mentioned in
our CLI anywhere. I thought it made sense to add a brief note to the `FILES`
help section, but I'm happy to put it somewhere else or rephrase it if someone
has a better suggestion!

Test Plan
--

Updated CLI tests
@ntBre ntBre added the documentation Improvements or additions to documentation label Jan 22, 2026
@astral-sh-bot
Copy link

astral-sh-bot bot commented Jan 22, 2026

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

@ntBre ntBre merged commit 82ed6eb into main Jan 23, 2026
42 checks passed
@ntBre ntBre deleted the brent/document-stdin branch January 23, 2026 16:55
carljm added a commit that referenced this pull request Jan 30, 2026
* main: (62 commits)
  [`refurb`] Do not add `abc.ABC` if already present (`FURB180`) (#22234)
  [ty] Add a new `assert-type-unspellable-subtype` diagnostic (#22815)
  [ty] Avoid duplicate syntax errors for `await` outside functions (#22826)
  [ty] Fix unary operator false-positive for constrained TypeVars (#22783)
  [ty] Fix binary operator false-positive for constrained TypeVars (#22782)
  [ty] Fix false-positive `unsupported-operator` for "symmetric" TypeVars (#22756)
  [`pydocstyle`] Clarify which quote styles are allowed (`D300`) (#22825)
  [ty] Use distributed versions of AND and OR on constraint sets (#22614)
  [ty] Add support for dict literals and dict() calls as default values for parameters with TypedDict types (#22161)
  Document `-` stdin convention in CLI help text (#22817)
  [ty] Make `infer_subscript_expression_types` a method on `Type` (#22731)
  [ty] Simplify `OverloadLiteral::spans` and `OverloadLiteral::parameter_span` (#22823)
  [ty] Require both `*args` and `**kwargs` when calling a `ParamSpec` callable (#22820)
  [ty] Handle tagged errors in conformance (#22746)
  Add `--color` cli option to force colored output (#22806)
  Identify notebooks by LSP didOpen instead of `.ipynb` file extension (#22810)
  [ty] Fix docstring rendering for literal blocks after doctests (#22676)
  [ty] Update salsa to fix out-of-order query validation (#22498)
  [ty] Inline cycle initial and recovery functions (#22814)
  [ty] Pass the generic context through the decorator (#22544)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants