Add globbing to isort sections docs (#11311)

Closes https://github.com/astral-sh/ruff/issues/11310.
This commit is contained in:
Charlie Marsh 2024-05-06 14:12:29 -04:00 committed by GitHub
parent 2f1983e4ad
commit a73b8c82a8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 13 additions and 6 deletions

View file

@ -1,12 +1,13 @@
doc-valid-idents = [
"StackOverflow",
"..",
"CodeQL",
"FastAPI",
"IPython",
"NumPy",
"LangChain",
"LibCST",
"McCabe",
"NumPy",
"SCREAMING_SNAKE_CASE",
"SQLAlchemy",
"McCabe",
"FastAPI",
"..",
"StackOverflow",
]

View file

@ -2267,6 +2267,12 @@ pub struct IsortOptions {
/// testing = ["pytest", "hypothesis"]
/// ```
///
/// The values in the list are treated as glob patterns. For example, to match all packages in
/// the LangChain ecosystem (`langchain-core`, `langchain-openai`, etc.):
/// ```toml
/// langchain = ["langchain-*"]
/// ```
///
/// Custom sections should typically be inserted into the `section-order` list to ensure that
/// they're displayed as a standalone group and in the intended order, as in:
/// ```toml

2
ruff.schema.json generated
View file

@ -1698,7 +1698,7 @@
}
},
"sections": {
"description": "A list of mappings from section names to modules.\n\nBy default, imports are categorized according to their type (e.g., `future`, `third-party`, and so on). This setting allows you to group modules into custom sections, to augment or override the built-in sections.\n\nFor example, to group all testing utilities, you could create a `testing` section: ```toml testing = [\"pytest\", \"hypothesis\"] ```\n\nCustom sections should typically be inserted into the `section-order` list to ensure that they're displayed as a standalone group and in the intended order, as in: ```toml section-order = [ \"future\", \"standard-library\", \"third-party\", \"first-party\", \"local-folder\", \"testing\" ] ```\n\nIf a custom section is omitted from `section-order`, imports in that section will be assigned to the `default-section` (which defaults to `third-party`).",
"description": "A list of mappings from section names to modules.\n\nBy default, imports are categorized according to their type (e.g., `future`, `third-party`, and so on). This setting allows you to group modules into custom sections, to augment or override the built-in sections.\n\nFor example, to group all testing utilities, you could create a `testing` section: ```toml testing = [\"pytest\", \"hypothesis\"] ```\n\nThe values in the list are treated as glob patterns. For example, to match all packages in the LangChain ecosystem (`langchain-core`, `langchain-openai`, etc.): ```toml langchain = [\"langchain-*\"] ```\n\nCustom sections should typically be inserted into the `section-order` list to ensure that they're displayed as a standalone group and in the intended order, as in: ```toml section-order = [ \"future\", \"standard-library\", \"third-party\", \"first-party\", \"local-folder\", \"testing\" ] ```\n\nIf a custom section is omitted from `section-order`, imports in that section will be assigned to the `default-section` (which defaults to `third-party`).",
"type": [
"object",
"null"