ReactiveX / ReactiveX/RxPY

switch_map() operator not listed in documentation

Open
#710 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5k
Forks
365
Avg merge
3d 14h
Merged PRs (30d)
4

Description

Hi,
Thanks for this useful library.
I'm trying to go through a tutorial which lists the switch_map() operator. I can see this operator in the code (as the alias of compose(map(project), switch_latest()) - line 3365 of reactivex.operators.__init__ but it doesn't show up in the docs.
I expected it because reactivex.io lists it as a standard operation and it is not clear how the alternative (switch_latest()) works as a sub.
Please consider making this change to the docs and API.
Regards,
Paul

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 in reactivex.operators.init around line 3365 and inspect how switch_map() is exposed as an alias of compose(map(project), switch_latest()). Then locate the operator API documentation and compare its treatment with switch_latest(); done means switch_map() is listed and its relationship to the alternative is clear.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.