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

Clarify language in range documentation #908

Open
nanewalt opened this issue Aug 21, 2024 · 6 comments
Open

Clarify language in range documentation #908

nanewalt opened this issue Aug 21, 2024 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@nanewalt
Copy link

nanewalt commented Aug 21, 2024

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

@nanewalt nanewalt added the documentation Improvements or additions to documentation label Aug 21, 2024
@encima encima transferred this issue from supabase/supabase Aug 21, 2024
@alinagarib
Copy link

can i be assigned to this issue?

@Avantika082
Copy link

Can you assign this issue to me?

@sharan286
Copy link

my good first issue. pls assign it to me.

@silentworks
Copy link
Contributor

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.

@RaghavgitGrover
Copy link

I have raised a PR (supabase/supabase#30989) to address the documentation issue mentioned here. The documentation now uses consistent parameter names (from and to) and has an updated description for the range offset behavior. Please review the changes!

@silentworks
Copy link
Contributor

@RaghavgitGrover please follow links in issues before creating new PRs. The OP opened a PR already and I stated what needs to happen in order for their PR to get merged in. supabase/supabase#28781 (comment)

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

6 participants