Skip to content

Commit

Permalink
change methods' signatures in TODO.md to previous commit
Browse files Browse the repository at this point in the history
  • Loading branch information
wchistow committed Jul 20, 2023
1 parent 519a19d commit 6dea147
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@
+ [X] change type of return value in method `Site.get` and, also in `Site.get_*` from `dict` to subclass of `typing.TypedDict`;
+ [ ] add more examples to directory `examples/`;
+ [ ] add more site-level methods with following signatures (of course, each of these methods needs tests):
+ [X] `get_answers(self, ids: list[int] | None = None, **kwargs: Any) -> list[Item]` - API method `answers/` and `answers/{ids}`;
+ [X] `get_articles(self, ids: list[int] | None = None, **kwargs: Any) -> list[Item]` - API method `articles/` and `answers/{ids}`;
+ [X] `get_collectives(self, slugs: list[str] | None = None, **kwargs: Any) -> list[Item]` - API method `collectives/` and `collectives/{slugs}`;
+ [X] `get_answers(self, ids: Iterable[int] | None = None, **kwargs: Any) -> list[Item]` - API method `answers/` and `answers/{ids}`;
+ [X] `get_articles(self, ids: Iterable[int] | None = None, **kwargs: Any) -> list[Item]` - API method `articles/` and `answers/{ids}`;
+ [X] `get_collectives(self, slugs: Iterable[str] | None = None, **kwargs: Any) -> list[Item]` - API method `collectives/` and `collectives/{slugs}`;
+ [X] `get_collective(self, slug: str, **kwargs: Any) -> Item`;
+ [X] `get_comments(self, ids: list[int] | None = None, **kwargs: Any) -> list[Item]` - API method `comments/` and `answers/{ids}`;
+ [X] `get_comments(self, ids: Iterable[int] | None = None, **kwargs: Any) -> list[Item]` - API method `comments/` and `answers/{ids}`;
+ [X] `get_comment(self, c_id: int, **kwargs: Any) -> Item | None`;
+ [X] `get_privileges(self, **kwargs: Any) -> list[Item]` - API method `privileges/`;
+ [X] `get_tags(self, **kwargs: Any) -> list[Item]` - API method `tags/`;
+ [X] `get_badges(self, **kwargs: Any) -> list[Item]` - API method `badges/`;
+ [X] `get_revisions(self, ids: list[int], **kwargs: Any) -> list[Item]` - API method `revisions/`;
+ [X] `get_posts(self, ids: list[int] | None = None, **kwargs: Any) -> list[Item]` - API method `posts/` and `posts/{ids}`;
+ [X] `get_revisions(self, ids: Iterable[int], **kwargs: Any) -> list[Item]` - API method `revisions/`;
+ [X] `get_posts(self, ids: Iterable[int] | None = None, **kwargs: Any) -> list[Item]` - API method `posts/` and `posts/{ids}`;
+ [X] `get_post(self, c_id: int, **kwargs: Any) -> Item | None`;
+ [X] `get_suggested_edits(self, ids: list[int] | None = None, **kwargs: Any) -> list[Item]` - API method `suggested-edits/` and `suggested-edits/{ids}`;
+ [X] `get_comments_on_answers(self, ids: list[int], **kwargs: Any) -> list[Item]` - API method `answers/{ids}/comments`;
+ [ ] `get_comments_on_articles(self, ids: list[int], **kwargs: Any) -> list[Item]` - API method `articles/{ids}/comments`;
+ [ ] `get_comments_on_posts(self, ids: list[int], **kwargs: Any) -> list[Item]` - API method `posts/{ids}/comments`;
+ [ ] `get_comments_on_questions(self, ids: list[int], **kwargs: Any) -> list[Item]` - API method `questions/{ids}/comments`;
+ [X] `get_suggested_edits(self, ids: Iterable[int] | None = None, **kwargs: Any) -> list[Item]` - API method `suggested-edits/` and `suggested-edits/{ids}`;
+ [X] `get_comments_on_answers(self, ids: Iterable[int], **kwargs: Any) -> list[Item]` - API method `answers/{ids}/comments`;
+ [ ] `get_comments_on_articles(self, ids: Iterable[int], **kwargs: Any) -> list[Item]` - API method `articles/{ids}/comments`;
+ [ ] `get_comments_on_posts(self, ids: Iterable[int], **kwargs: Any) -> list[Item]` - API method `posts/{ids}/comments`;
+ [ ] `get_comments_on_questions(self, ids: Iterable[int], **kwargs: Any) -> list[Item]` - API method `questions/{ids}/comments`;
+ [X] `get_non_tag_based_badges(self, **kwargs: Any) -> list[Item]` - API method `badges/name`;
+ [X] `IndexError` raises in methods `Site.get_<singular>`, when there is no items in response;
+ [X] add constant `API_VERSION` to file `tests/test_client/__init__.py` and usage of it to tests.
Expand Down

0 comments on commit 6dea147

Please sign in to comment.