Skip to content

Update ConfigEntry docstring to sync with attributes #852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 2 commits into from
Jul 14, 2025
Merged

Update ConfigEntry docstring to sync with attributes #852

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77bca16
Update `ConfigEntry` docstring to sync with attributes
nathanjmcdougall Jul 14, 2025
960ae61
Fix grammar
nathanjmcdougall Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/usethis/_tool/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,10 @@ class ConfigEntry(BaseModel):

Attributes:
keys: A sequentially nested sequence of keys giving a single configuration item.
value: The default value to be placed at the under the key sequence. By default,
no configuration will be added, which is most appropriate for top-level
configuration sections like [tool.usethis] under which the entire tool's
config gets placed.

get_value: A callable returning the default value to be placed at the key
sequence. By default, no configuration will be added, which is most
appropriate for top-level configuration sections like [tool.usethis]
under which the entire tool's config gets placed.
"""

keys: list[Key]
Expand Down
Loading