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

Improve PaginatedList docs #654

Merged

Conversation

bennettscience
Copy link
Contributor

Include details for each parameter used in PaginatedList.

Fixes #651.

Include details for each parameter used in PaginatedList.
Include details for each parameter used in PaginatedList.
@bennettscience
Copy link
Contributor Author

I'm not sure why the flake8 check is failing - it's passing locally.

@jonespm
Copy link
Contributor

jonespm commented May 11, 2024

Looks like some error with the Codecov action not with this PR. I'm don't think I have the permission to look into this any more. Maybe it'll pass when run tomorrow or Monday.

@Thetwam
Copy link
Member

Thetwam commented May 11, 2024

Think I fixed the Codecov thing in #655 and by updating the upload token. (Not sure if it was one, the other, or both, but hey).

Get that in and this should hopefully work

Copy link

codecov bot commented May 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1196b01) to head (e9eb1ec).

Additional details and impacted files
@@            Coverage Diff            @@
##           develop      #654   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           73        73           
  Lines         3732      3732           
=========================================
  Hits          3732      3732           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@Thetwam Thetwam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding docs! The docstring on __init__ is super useful.

I'm concerned the addition to the class docstring may be misleading.

canvasapi/paginated_list.py Outdated Show resolved Hide resolved
Copy link
Member

@Thetwam Thetwam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 👍

@Thetwam Thetwam merged commit c1e8556 into ucfopen:develop May 12, 2024
7 checks passed
@bennettscience bennettscience deleted the issue/651-paginatedlist-docstring branch May 14, 2024 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve PaginatedList docs
3 participants