Documentation updates - Githubissues

lemon24 / reader

A Python feed reader library.

https://reader.readthedocs.io

BSD 3-Clause "New" or "Revised" License

438 stars 36 forks source link

Documentation updates #257

Open lemon24 opened 2 years ago

lemon24 commented 2 years ago

User guide:

[x] Replace list(reader.get_entries())[:2] with reader.get_entries(limit=2) throughout.
[ ] (maybe) Add guidance (on naming etc.) for plugin authors.
[ ] User-added entries (#239).

Read me:

[x] Mention that reader helps users track their consumption (via count averages, and read/important_modified).

API docs:

[ ] Use literals instead of str for argument types in docstrings.
[ ] Types for Entry, Feed etc. attributes aren't showing.
[x] Use Sphinx to show exception inheritance.
[ ] As of August 2023, instance attributes are missing for exceptions (e.g. FeedError is missing url).