search

supabase / supabase-py

Python Client for Supabase. Query Postgres from Flask, Django, FastAPI. Python user authentication, security policies, edge functions, file storage, and realtime data streaming. Good first issue.
https://supabase.com/docs/reference/python
MIT License
1.75k stars 207 forks source link

Clarify language in `range` documentation #908

Open nanewalt opened 3 months ago

nanewalt commented 3 months ago

Improve documentation

Link

https://supabase.com/docs/reference/python/range

Describe the problem

The python range documentation has the following issues:

  1. Inconsistent naming - The parameter list uses start and end while the description uses from and to
  2. Incorrect offset end description - The description states that the result is limited by "starting at an offset (from) and ending at the offset (from + to)". This is incorrect as the end index is just to. E.g. range(20, 30) returns 11 items (20-30), not 51 items (20-20+30)

Describe the improvement

  1. Range indices are references as from and to in parameter list. This is aligned with the documentation for other languages.
  2. Description states that range offset ends at just to

Additional context

PR supabase/supabase#28781

relevant implementation

alinagarib commented 1 month ago

can i be assigned to this issue?

Avantika082 commented 2 weeks ago

Can you assign this issue to me?

sharan286 commented 2 weeks ago

my good first issue. pls assign it to me.

silentworks commented 1 week ago

There is no need for an issue to be assigned to anyone, just work on it and create a PR as that's how OS projects on GitHub work.