ReactiveX / ReactiveX/rxjs

docs(range): unclear parameters description

Open
#5,721 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
31.7k
Forks
3k
PR merge metrics
No merged PRs in 30d

Description

Documentation Related To Component:

range

Please check those that apply
  • typo
  • documentation doesn't exist
  • documentation needs clarification
  • error(s) in example
  • needs example
Description Of The Issue

The signature

range(start: number = 0, count?: number, scheduler?: SchedulerLike): Observable<number>

suggests that range(n) is equivalent to range(n, undefined), but it's actually range(0, n).

Maybe add an overload range(count: number) .

Less importantly, range(n, Infinity) emits an infinite sequence, contrary to the documentation.

Observable: An Observable of numbers that emits a finite range of sequential integers.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the range API documentation and the signature shown in the issue. Verify how the one-argument form and an infinite count are described, then update the parameter or overload documentation so the actual behavior and finite-range wording are clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.