[ty] Clarify ty check output default in documentation.#18246
Merged
MichaReiser merged 2 commits intoastral-sh:mainfrom May 22, 2025
Merged
[ty] Clarify ty check output default in documentation.#18246MichaReiser merged 2 commits intoastral-sh:mainfrom
ty check output default in documentation.#18246MichaReiser merged 2 commits intoastral-sh:mainfrom
Conversation
Contributor
|
Contributor
|
@MichaReiser This seems like useful information for users to have in the command reference; should we just add it in the comment at Line 289 in d098118 [#default] annotation?
|
Member
This seems hard because it requires understanding Rust code. But yes, we should update the docs comment in |
Member
|
Thanks |
sharkdp
pushed a commit
to astral-sh/ty
that referenced
this pull request
May 23, 2025
…490) ## Summary Explain in `CONTRIBUTING.md` that some ty help text and reference documentation result from source code that lives in Ruff, and point to sources, to help tech writer contributors. Inspired by my stumble in #478 and subsequent pointers in astral-sh/ruff#18246 . ## Test Plan I used `git grep` to search the Ruff repository for several chunks of the prose in `docs/reference/` to verify which source code contains text that turns into the autogenerated docs. I pushed my branch to GitHub and manually checked that the formatting and hyperlinks were correct.
epitech314
added a commit
to epitech314/ty
that referenced
this pull request
Nov 12, 2025
…#490) ## Summary Explain in `CONTRIBUTING.md` that some ty help text and reference documentation result from source code that lives in Ruff, and point to sources, to help tech writer contributors. Inspired by my stumble in #478 and subsequent pointers in astral-sh/ruff#18246 . ## Test Plan I used `git grep` to search the Ruff repository for several chunks of the prose in `docs/reference/` to verify which source code contains text that turns into the autogenerated docs. I pushed my branch to GitHub and manually checked that the formatting and hyperlinks were correct.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a "[default]" note in the CLI documentation to indicate that, by default,
ty checkprints "full" diagnostic output, not "concise" output.Was: astral-sh/ty#478 .
Test Plan
I pushed the branch, and read the preview of the Markdown file on GitHub in my browser.