Skip to content

Commit

Permalink
Fix typo and grammar in CLI env_file description.
Browse files Browse the repository at this point in the history 
    - Corrected "then" to "when" in the description.
    - Fixed grammar: changed "which require values" to "which requires values."
  • Loading branch information
@jag-k
jag-k committed Feb 18, 2025
1 parent ed89e66 commit d9317c2
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 27 deletions.
14 changes: 7 additions & 7 deletions docs/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ The settings for the CLI.

**Environment Prefix**: `PYDANTIC_SETTINGS_EXPORT__`

| Name | Type | Default | Description | Example |
|----------------------------------------------|----------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `PYDANTIC_SETTINGS_EXPORT__DEFAULT_SETTINGS` | `array` | `[]` | The default settings to use. The settings are applied in the order they are listed. | `["settings:settings"]`, `["app.config.settings:Settings","app.config.settings.dev:Settings"]` |
| `PYDANTIC_SETTINGS_EXPORT__ROOT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__PROJECT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__RESPECT_EXCLUDE` | `boolean` | `true` | Respect the exclude attribute in the fields. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__ENV_FILE` | `Path` \| `NoneType` | `null` | The path to the `.env` file to load environment variables. Useful then you have a Settings class/instance, which require values while running. | `null` |
| Name | Type | Default | Description | Example |
|----------------------------------------------|----------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `PYDANTIC_SETTINGS_EXPORT__DEFAULT_SETTINGS` | `array` | `[]` | The default settings to use. The settings are applied in the order they are listed. | `["settings:settings"]`, `["app.config.settings:Settings","app.config.settings.dev:Settings"]` |
| `PYDANTIC_SETTINGS_EXPORT__ROOT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__PROJECT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__RESPECT_EXCLUDE` | `boolean` | `true` | Respect the exclude attribute in the fields. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__ENV_FILE` | `Path` \| `NoneType` | `null` | he path to the .env file to load environment variables. Useful when you have a Settings class/instance, which requires values while running. | `null` |

### Relative Directory Settings

Expand Down
18 changes: 9 additions & 9 deletions docs/InjectedConfiguration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Here is an example of injected configuration with region name `config`:
<!-- region:config -->
Injected Configuration. Just a table.

| Name | Type | Default | Description | Example |
|------------------------------------------------------------|----------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `PYDANTIC_SETTINGS_EXPORT__DEFAULT_SETTINGS` | `array` | `[]` | The default settings to use. The settings are applied in the order they are listed. | `["settings:settings"]`, `["app.config.settings:Settings","app.config.settings.dev:Settings"]` |
| `PYDANTIC_SETTINGS_EXPORT__ROOT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__PROJECT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__RESPECT_EXCLUDE` | `boolean` | `true` | Respect the exclude attribute in the fields. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__ENV_FILE` | `Path` \| `NoneType` | `null` | The path to the `.env` file to load environment variables. Useful then you have a Settings class/instance, which require values while running. | `null` |
| `PYDANTIC_SETTINGS_EXPORT__RELATIVE_TO__REPLACE_ABS_PATHS` | `boolean` | `true` | Replace absolute paths with relative path to project root. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__RELATIVE_TO__ALIAS` | `string` | `"<project_dir>"` | The alias for the relative directory. | `"<project_dir>"` |
| Name | Type | Default | Description | Example |
|------------------------------------------------------------|----------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `PYDANTIC_SETTINGS_EXPORT__DEFAULT_SETTINGS` | `array` | `[]` | The default settings to use. The settings are applied in the order they are listed. | `["settings:settings"]`, `["app.config.settings:Settings","app.config.settings.dev:Settings"]` |
| `PYDANTIC_SETTINGS_EXPORT__ROOT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__PROJECT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__RESPECT_EXCLUDE` | `boolean` | `true` | Respect the exclude attribute in the fields. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__ENV_FILE` | `Path` \| `NoneType` | `null` | he path to the .env file to load environment variables. Useful when you have a Settings class/instance, which requires values while running. | `null` |
| `PYDANTIC_SETTINGS_EXPORT__RELATIVE_TO__REPLACE_ABS_PATHS` | `boolean` | `true` | Replace absolute paths with relative path to project root. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__RELATIVE_TO__ALIAS` | `string` | `"<project_dir>"` | The alias for the relative directory. | `"<project_dir>"` |
<!-- endregion:config -->
18 changes: 9 additions & 9 deletions docs/SimpleConfiguration.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Simple Configuration. Just a table.

| Name | Type | Default | Description | Example |
|------------------------------------------------------------|----------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `PYDANTIC_SETTINGS_EXPORT__DEFAULT_SETTINGS` | `array` | `[]` | The default settings to use. The settings are applied in the order they are listed. | `["settings:settings"]`, `["app.config.settings:Settings","app.config.settings.dev:Settings"]` |
| `PYDANTIC_SETTINGS_EXPORT__ROOT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__PROJECT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__RESPECT_EXCLUDE` | `boolean` | `true` | Respect the exclude attribute in the fields. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__ENV_FILE` | `Path` \| `NoneType` | `null` | The path to the `.env` file to load environment variables. Useful then you have a Settings class/instance, which require values while running. | `null` |
| `PYDANTIC_SETTINGS_EXPORT__RELATIVE_TO__REPLACE_ABS_PATHS` | `boolean` | `true` | Replace absolute paths with relative path to project root. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__RELATIVE_TO__ALIAS` | `string` | `"<project_dir>"` | The alias for the relative directory. | `"<project_dir>"` |
| Name | Type | Default | Description | Example |
|------------------------------------------------------------|----------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `PYDANTIC_SETTINGS_EXPORT__DEFAULT_SETTINGS` | `array` | `[]` | The default settings to use. The settings are applied in the order they are listed. | `["settings:settings"]`, `["app.config.settings:Settings","app.config.settings.dev:Settings"]` |
| `PYDANTIC_SETTINGS_EXPORT__ROOT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__PROJECT_DIR` | `Path` | `"<project_dir>"` | The project directory. Used for relative paths in the configuration file and .env file. | `"<project_dir>"` |
| `PYDANTIC_SETTINGS_EXPORT__RESPECT_EXCLUDE` | `boolean` | `true` | Respect the exclude attribute in the fields. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__ENV_FILE` | `Path` \| `NoneType` | `null` | he path to the .env file to load environment variables. Useful when you have a Settings class/instance, which requires values while running. | `null` |
| `PYDANTIC_SETTINGS_EXPORT__RELATIVE_TO__REPLACE_ABS_PATHS` | `boolean` | `true` | Replace absolute paths with relative path to project root. | `true` |
| `PYDANTIC_SETTINGS_EXPORT__RELATIVE_TO__ALIAS` | `string` | `"<project_dir>"` | The alias for the relative directory. | `"<project_dir>"` |
4 changes: 2 additions & 2 deletions pydantic_settings_export/cli.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ class PSECLISettings(PSESettings):
env_file: Path | None = Field(
None,
description=(
"The path to the `.env` file to load environment variables. "
"Useful then you have a Settings class/instance, which require values while running."
"he path to the .env file to load environment variables. "
"Useful when you have a Settings class/instance, which requires values while running."
),
)

Expand Down

0 comments on commit d9317c2

Please sign in to comment.