Skip to content

docs(client): fix inaccurate and misleading docstrings#63

Merged
fguillot merged 1 commit intomainfrom
docs/fix-docstrings
Mar 24, 2026
Merged

docs(client): fix inaccurate and misleading docstrings#63
fguillot merged 1 commit intomainfrom
docs/fix-docstrings

Conversation

@fguillot
Copy link
Copy Markdown
Member

  • Fix typos: "excepted" → "except", "belongs" → "belong"
  • Remove "False otherwise" from methods that only return True or raise
  • Correct return descriptions for get_entries, get_feed_entries, and get_category_entries to reflect the actual dict return type
  • Remove bogus Returns section from mark_feed_entries_as_read

- Fix typos: "excepted" → "except", "belongs" → "belong"
- Remove "False otherwise" from methods that only return True or raise
- Correct return descriptions for get_entries, get_feed_entries, and
  get_category_entries to reflect the actual dict return type
- Remove bogus Returns section from mark_feed_entries_as_read
@fguillot fguillot merged commit 7a6e859 into main Mar 24, 2026
6 checks passed
@fguillot fguillot deleted the docs/fix-docstrings branch March 24, 2026 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant