Skip to content

Commit

Permalink
More readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
xfenix committed Oct 12, 2023
1 parent d3584f7 commit 4fa5213
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Also it supports feature called «user dictionaries» — user can add his own w
## Configuration
### Config options
You can change config of the service by changing the environment variables. Here is a list of them:
* `SPELLCHECK_SENTRY_DSN` Sentry DSN for integration. Empty field disables integration. Default value is ``.
* `SPELLCHECK_API_KEY` define api key for users dictionaries mostly. Please, provide, if you want to enable user dictionaries API. Default value is ``.
* `SPELLCHECK_SENTRY_DSN` Sentry DSN for integration. Empty field disables integration. Default value is empty string.
* `SPELLCHECK_API_KEY` define api key for users dictionaries mostly. Please, provide, if you want to enable user dictionaries API. Default value is empty string.
* `SPELLCHECK_ENABLE_CORS` enable CORS for all endpoints. In docker container this option is disabled. Default value is `True`.
* `SPELLCHECK_STRUCTURED_LOGGING` enables structured (json) logging. Default value is `True`.
* `SPELLCHECK_WORKERS` define application server workers count. If you plan to use k8s and only scale with replica sets, you might want to reduce this value to `1`. Default value is `8`. Restrictions: `Gt(gt=0)`, `Lt(lt=301)`
Expand Down
7 changes: 6 additions & 1 deletion scripts/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,15 @@ def _update_readme() -> None:
if field_properties.description is None:
print("-", one_field_name, "not be available in README")
continue
default_value_beautified: str = (
"empty string"
if isinstance(field_properties.default, str) and not field_properties.default
else f"`{field_properties.default}`"
)
one_row_parts = [
f"`{(env_prefix_value + one_field_name).upper()}`",
field_properties.description + ".",
f"Default value is `{field_properties.default}`.",
f"Default value is {default_value_beautified}.",
]
if field_properties.metadata:
validators_buf: list[str] = []
Expand Down

0 comments on commit 4fa5213

Please sign in to comment.