Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #257

Open
3 of 8 tasks
lemon24 opened this issue Oct 8, 2021 · 0 comments
Open
3 of 8 tasks

Documentation updates #257

lemon24 opened this issue Oct 8, 2021 · 0 comments

Comments

@lemon24
Copy link
Owner

lemon24 commented Oct 8, 2021

User guide:

Read me:

  • 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.
  • Use Sphinx to show exception inheritance.
  • As of August 2023, instance attributes are missing for exceptions (e.g. FeedError is missing url).
@lemon24 lemon24 mentioned this issue Oct 12, 2021
@lemon24 lemon24 changed the title User guide updates Documentation updates Oct 16, 2021
lemon24 added a commit that referenced this issue Oct 28, 2021
@reminders reminders bot added the reminder label Aug 4, 2023
Repository owner deleted a comment from reminders bot Aug 4, 2023
@lemon24 lemon24 removed the reminder label Aug 4, 2023
lemon24 added a commit that referenced this issue Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant