diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-03-20 15:19:58 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-03-24 16:46:27 -0500 |
| commit | ab18e06217a8a1902d1859aae6b033f469b2232b (patch) | |
| tree | 98136dffa4d16ed3d645e2bdee1ac60421001ff7 /CONTRIBUTING.md | |
| parent | 78819897213ec3bff57d4c7094fd585dbb8d48d4 (diff) | |
| download | requests-cache-ab18e06217a8a1902d1859aae6b033f469b2232b.tar.gz | |
More usage examples, formatting, and editing for Readme + Sphinx docs
* Closes #135, #165
* Add a 'Summary' section at the top of the Readme explaining the scope of requests-cache and why you would want to use it
* Add some more info explaining the difference between using `CachedSession` directly vs. patching with `install_cache()`
* Move basic examples from 'User Guide' section into Readme
* Include Readme in Sphinx docs (using `.. mdinclude::`) and remove duplicate sections
* Include Contributing guide in Sphinx docs
* Convert History doc to markdown and include in Sphinx docs
* Use `automod` options to move main cache documentation from `CacheMixin` back to to `CachedSession`, since that's probably where a user will look first
* Add more detailed usage examples to an 'Advanced Usage' section for `CachedSession` options (`filter_fn`, `ignore_parameters`, etc.)
* Update example scripts and move them to `examples/` folder
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a217e9..64d0cd2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ If you have an issue or PR that hasn't received a response in a timely manner, o discuss ideas about the project in general, please reach out on the Code Shelter chat server, under [projects/requests-cache](https://codeshelter.zulipchat.com/#narrow/stream/186993-projects/topic/requests-cache). -## Installation +## Dev Installation To set up for local development: ```bash @@ -24,7 +24,7 @@ $ cd requests-cache $ pip install -Ue ".[dev]" ``` -## Pre-commit hooks +## Pre-commit Hooks [Pre-commit](https://github.com/pre-commit/pre-commit) config is included to run the same checks locally that are run in CI jobs by GitHub Actions. This is optional but recommended. ```bash |