aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-01-26 17:17:38 -0600
committerEugene Triguba <eugenetriguba@gmail.com>2020-01-26 17:17:38 -0600
commit39cc3d5a0a717199783c292373e181e410608344 (patch)
treefa05b16c5e3de70d01695837b96545c8ae527315 /README.md
parentMerge branch 'master' of github.com:eugenetriguba/config_file (diff)
downloadconfig-file-39cc3d5a0a717199783c292373e181e410608344.zip
Rename reset() to restore_original()
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index cf81e5d..f59a2ed 100644
--- a/README.md
+++ b/README.md
@@ -102,24 +102,25 @@ config.has('calendar.start_week_on_sunday')
```
### Save when you're done
-The contents are only written back out when you call `save()`.
+The contents are only written back out when you call `save()`. `set()` and `delete()` both
+modify the contents of the file and
```python
config.save()
>>> True
```
-### Reset the file back to its original
+### Restore the file back to its original
The current configuration file would be deleted and replaced by a copy of the original.
-By default, since our passed in config file was at path `~/.config/test/config.ini`, `reset()`
-will look for `~/.config/test/config.original.ini`.
+By default, since our passed in config file was at path `~/.config/test/config.ini`,
+`restore_original()` will look for `~/.config/test/config.original.ini`.
```python
-config.reset()
+config.restore_original()
>>> True
# But you can also specify the original config file explicitly.
-config.reset(original_file_path="~/some_other_directory/this_is_actually_the_original.ini")
+config.restore_original(original_file_path="~/some_other_directory/this_is_actually_the_original.ini")
>>> True
```