Skip to content
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.

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

✏️ Fix minor typo in documentation #40

Merged
merged 3 commits into from
Sep 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion cliconfig/dict_routines.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ def merge_flat(
if not allow_new_keys:
# Check that there are no new keys in dict2
for key in flat_dict2:
if key not in flat_dict1.keys():
if key not in flat_dict1:
raise ValueError(
f"New parameter found '{key}' in that is not in the original "
"dict."
Expand Down
4 changes: 2 additions & 2 deletions docs/processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ class ProcessPrintSorted(Processing):
return flat_config

# And to use it:
config = make_config("main.yaml", process_list=[ProcessProtect()])
config = make_config("main.yaml", process_list=[ProcessPrintSorted()])
```

**Important note**: After all pre-merge processings, the config should no longer contains
Expand All @@ -281,7 +281,7 @@ on the config are not actually to merge, save, and load a config, but rather:

These three operations are in `cliconfig.process_routines` and called
`merge_processing`, `save_processing`, and `load_processing`, respectively. They
takes as input a Config object that contains as we see the list of processing.
take as input a Config object that contains as we see the list of processing.

Now, the trick is that sometimes we want to apply these operations to the processing
themselves, particularly when we want to modify a part of the configuration instead
Expand Down
2 changes: 0 additions & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,8 @@ file (space is important) but as a parameter called "config" with value "first.y
(it then raises an error if no "config" parameter is on the default config).

```bash

Now the config look like this:

```python
Config:
param1: -1 # (overridden by second.yaml)
param2: -2 # (overridden by command line args)
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ pytest
pytest-check
pytest-cov
pytest-mock
ruff==0.0.261
ruff==0.0.287
Loading