Skip to content

Commit ab871fc

Browse files
committed
update readme; add Q&A
1 parent a4f8009 commit ab871fc

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,12 +225,27 @@ With ```cache_info```, you can retrieve the number of ```hits``` and ```misses``
225225
- Clear the cache by ```f.cache_clear()```.
226226
- Disable `SyntaxWarning` by ```memoization.suppress_warnings()```.
227227

228+
## Q&A
229+
230+
1. **Q: There are duplicated code in `memoization` and most of them can be eliminated by using another level of
231+
abstraction (e.g. classes and multiple inheritance). Why not refactor?**
232+
233+
A: We would like to keep the code in a proper level of abstraction. However, these abstractions make it run slower.
234+
As this is a caching library focusing on speed, we have to give up some elegance for better performance. We consider
235+
refactoring for better code maintainability while keeping good performance as a future work.
236+
237+
238+
2. **Q: I have submitted an issue and not received a reply for a long time. Anyone can help me?**
239+
240+
A: Sorry! We are not working full-time, but working voluntarily on this project, so you might experience some delay.
241+
We appreciate your patience.
242+
228243

229244
## Contributing
230245

231246
This project welcomes contributions from anyone.
232247
- [Read Contributing Guidance](https://github.com/lonelyenvoy/python-memoization/blob/master/CONTRIBUTING.md) first.
233-
- [Submit bugs](https://github.com/lonelyenvoy/python-memoization/issues) and help me verify fixes.
248+
- [Submit bugs](https://github.com/lonelyenvoy/python-memoization/issues) and help us verify fixes.
234249
- [Submit pull requests](https://github.com/lonelyenvoy/python-memoization/pulls) for bug fixes and features and discuss existing proposals. Please make sure that your PR passes the tests in ```test.py```.
235250
- [See contributors](https://github.com/lonelyenvoy/python-memoization/blob/master/CONTRIBUTORS.md) of this project.
236251

0 commit comments

Comments
 (0)