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

Document additional functionality (e.g. resolve_params, set_params) #1147

Open
widal001 opened this issue Apr 30, 2024 · 2 comments
Open

Document additional functionality (e.g. resolve_params, set_params) #1147

widal001 opened this issue Apr 30, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@widal001
Copy link

          @widal001 I would love it if you could help me with documentation.

I feel like there is a lot of functionality that is not covered in the documentation.

For instance, here is the functionality from https://github.com/uriyyo/fastapi-pagination/blob/main/fastapi_pagination/api.py that is not covered at all:

  • resolve_params
  • create_page
  • set_params
  • set_page
  • set_items_transformer
  • pagination_ctx

These are the first things that come to my mind, I am sure that there is more to cover. It will be also great to improve existing docs.

Originally posted by @uriyyo in #265 (comment)

@uriyyo uriyyo added the documentation Improvements or additions to documentation label Apr 30, 2024
@widal001
Copy link
Author

@uriyyo I created this to reference the work that I'll plan to do related to documentation. Feel free to assign this ticket to me and I'll create a PR that references this issue!

@uriyyo
Copy link
Owner

uriyyo commented Apr 30, 2024

@widal001 Great, thank you so much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants