search

yazdipour / OmnivoreQL

@Omnivore-app API client for Python
https://pypi.org/project/omnivoreql/
MIT License
69 stars 6 forks source link

fix: Update pydoc #26

Closed yazdipour closed 5 months ago

yazdipour commented 5 months ago

Closes #9

ℹ Additional Information

sourcery-ai[bot] commented 5 months ago

Reviewer's Guide by Sourcery

This pull request updates the docstring for the get_articles method in the omnivoreql.py file to include information about the default limit of 100 articles. This change ensures that users are aware of the default behavior and can use the limit and cursor parameters to fetch more articles if needed.

File-Level Changes

Files Changes
omnivoreql/omnivoreql.py Updated the docstring for the get_articles method to specify the default limit of 100 articles.
Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - You can change your review settings at any time by accessing your [dashboard](https://sourcery.ai/dashboard): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
thiswillbeyourgithub commented 5 months ago

To be clear : that means that I can now fetch all my articles using ahigh enough limit? Or is there another limit that you're aware of?

yazdipour commented 5 months ago

You are right, its basically max 100 not default 100. They really need to add doc for their api. also cursor is an integer but api gets string. why? who knows. i am going to adjust it on python side.