Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix typo in src option docs (#2201)

This commit is contained in:
jvstme 2023-01-26 17:23:09 +00:00 committed by GitHub
parent f3aa409d9a
commit 0ad6b8224d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -2443,7 +2443,7 @@ my_package/
bar.py bar.py
``` ```
The `src` directory should be included in `source` (e.g., `source = The `src` directory should be included in the `src` option (e.g., `src =
["src"]`), such that when resolving imports, `my_package.foo` is ["src"]`), such that when resolving imports, `my_package.foo` is
considered a first-party import. considered a first-party import.

2
ruff.schema.json
View File

@ -421,7 +421,7 @@
] ]
}, },
"src": { "src": {
"description": "The source code paths to consider, e.g., when resolving first- vs. third-party imports.\n\nAs an example: given a Python package structure like:\n\n```text my_package/ pyproject.toml src/ my_package/ __init__.py foo.py bar.py ```\n\nThe `src` directory should be included in `source` (e.g., `source = [\"src\"]`), such that when resolving imports, `my_package.foo` is considered a first-party import.\n\nThis field supports globs. For example, if you have a series of Python packages in a `python_modules` directory, `src = [\"python_modules/*\"]` would expand to incorporate all of the packages in that directory. User home directory and environment variables will also be expanded.", "description": "The source code paths to consider, e.g., when resolving first- vs. third-party imports.\n\nAs an example: given a Python package structure like:\n\n```text my_package/ pyproject.toml src/ my_package/ __init__.py foo.py bar.py ```\n\nThe `src` directory should be included in the `src` option (e.g., `src = [\"src\"]`), such that when resolving imports, `my_package.foo` is considered a first-party import.\n\nThis field supports globs. For example, if you have a series of Python packages in a `python_modules` directory, `src = [\"python_modules/*\"]` would expand to incorporate all of the packages in that directory. User home directory and environment variables will also be expanded.",
"type": [ "type": [
"array", "array",
"null" "null"

2
src/settings/options.rs
View File

@ -342,7 +342,7 @@ pub struct Options {
/// bar.py /// bar.py
/// ``` /// ```
/// ///
/// The `src` directory should be included in `source` (e.g., `source = /// The `src` directory should be included in the `src` option (e.g., `src =
/// ["src"]`), such that when resolving imports, `my_package.foo` is /// ["src"]`), such that when resolving imports, `my_package.foo` is
/// considered a first-party import. /// considered a first-party import.
/// ///