[ty] Fix incorrect type of src.root in documentation#18040
Merged
MichaReiser merged 1 commit intomainfrom May 12, 2025
Merged
Conversation
MichaReiser
requested review from
AlexWaygood,
carljm,
dcreager and
sharkdp
as code owners
MichaReiser
added
documentation
AlexWaygood
approved these changes
May 12, 2025
AlexWaygood
reviewed
May 12, 2025
| The root(s) of the project, used for finding first-party modules. | ||
| The root of the project, used for finding first-party modules. | ||
|
|
||
| **Default value**: `[".", "./src"]` |
Member
There was a problem hiding this comment.
Hmm, it's weird that we default to multiple values if users can't set it to multiple values
Member
Author
There was a problem hiding this comment.
Yeah, it is. Not sure how to fix.
Member
There was a problem hiding this comment.
Maybe instead of referring to a default value, we could say something like
Suggested change
| **Default value**: `[".", "./src"]` | |
| **If not set, two first-party roots are inferred by default: `"."` and `"./src"`** |
?
Contributor
|
dcreager
added a commit
that referenced
this pull request
May 12, 2025
* main: disable jemalloc on android (#18033) [ty] Fix incorrect type of `src.root` in documentation (#18040) [ty] Refine message for why a rule is enabled (#18038) [ty] Remove brackets around option names (#18037) Update pre-commit dependencies (#18025) Update docker/build-push-action action to v6.16.0 (#18030) Update docker/login-action action to v3.4.0 (#18031) Update taiki-e/install-action digest to 83254c5 (#18022) Update cargo-bins/cargo-binstall action to v1.12.4 (#18023) Update Rust crate ctrlc to v3.4.7 (#18027) Update Rust crate clap to v4.5.38 (#18026) Update Rust crate jiff to v0.2.13 (#18029) Update Rust crate getrandom to v0.3.3 (#18028) Update dependency ruff to v0.11.9 (#18024) [`pylint`] add fix safety section (`PLW1514`) (#17932) python_stdlib: update for 3.14 (#18014) [`ruff`] add fix safety section (`RUF033`) (#17760) [`pylint`] add fix safety section (`PLC0414`) (#17802)
Glyphack
pushed a commit
to Glyphack/ruff
that referenced
this pull request
May 21, 2025
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
2 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
src.rootis a single path. We do have plans to change the setting to a list (need to think about if we should allow empty lists) astral-sh/ty#179 but we can change that later.Test Plan
See updated docs