Skip to content

Commit 66bd714

Browse files
Bordapre-commit-ci[bot]Copilot
authored
Update documentation and remove redundant section (#325)
* Update documentation and remove redundant section * Update AGENTS.md --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent a82fe54 commit 66bd714

2 files changed

Lines changed: 3 additions & 23 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -156,29 +156,7 @@ ______________________________________________________________________
156156

157157
### General structure
158158

159-
The repository contains a Python package called Cachier that provides persistent function caching with several backends:
160-
161-
cachier/
162-
├── src/cachier/ # Main library code
163-
│ ├── __init__.py
164-
│ ├── core.py # Decorator logic, backend selection
165-
│ ├── cores/ # Backend implementations
166-
│ │ ├── pickle.py
167-
│ │ ├── memory.py
168-
│ │ ├── mongo.py
169-
│ │ ├── sql.py
170-
│ │ ├── redis.py
171-
│ │ └── base.py
172-
│ ├── config.py # Global/default config
173-
│ ├── \_types.py # Type definitions
174-
│ ├── _version.py
175-
│ └── __main__.py
176-
├── tests/ # Pytest-based tests, backend-marked
177-
│ ├── test_\*.py
178-
│ └── \*\_requirements.txt # Backend-specific test requirements
179-
├── examples/ # Usage examples
180-
├── README.rst # Main documentation
181-
└── ...
159+
For an up-to-date overview of the repository layout, see `README.rst` in the project root.
182160

183161
### Key functionality
184162

CLAUDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ ______________________________________________________________________
158158

159159
The repository contains a Python package called Cachier that provides persistent function caching with several backends:
160160

161+
```
161162
cachier/
162163
├── src/cachier/ # Main library code
163164
│ ├── __init__.py
@@ -179,6 +180,7 @@ cachier/
179180
├── examples/ # Usage examples
180181
├── README.rst # Main documentation
181182
└── ...
183+
```
182184

183185
### Key functionality
184186

0 commit comments

Comments
 (0)