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.

Sign up for GitHub

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

Jump to bottom

docs(operators): Add a simple example in doc string #4636

Merged
merged 4 commits into from
Mar 18, 2019
Merged

docs(operators): Add a simple example in doc string #4636

merged 4 commits into from
Mar 18, 2019

Conversation

xuemind
Copy link
Contributor

@xuemind xuemind commented Mar 14, 2019

Add much simpler example to help understand what switchMap can do. It is easy to understand for document reader.

Description:

Related issue (if exists):

@xuemind
docs(operators): describe your change...
aa721f3 
Add much simpler example to help understand what `switchMap` can do. It is easy to understand for document reader.
@xuemind
update the sample to following TS grammar
874f8a7
xuemind
xuemind commented Mar 15, 2019
View reviewed changes
Copy link
Contributor Author

@xuemind xuemind left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update the sample to following Typescript grammar

@rxjs-bot
Copy link

Warnings
⚠️

commit message does not follows conventional change log (1)

(1) : RxJS uses conventional change log to generate changelog automatically. It seems some of commit messages are not following those, please check contributing guideline and update commit messages.

Generated by 🚫 dangerJS

@coveralls
Copy link

coveralls commented Mar 15, 2019 •
edited
Loading

Pull Request Test Coverage Report for Build 8243

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 19 unchanged lines in 3 files lost coverage.
  • Overall coverage decreased (-0.008%) to 96.954%
Files with Coverage Reduction New Missed Lines %
src/internal/observable/race.ts 1 95.0%
src/internal/operators/throwIfEmpty.ts 1 93.94%
src/internal/observable/ConnectableObservable.ts 17 56.3%
Totals Coverage Status
Change from base Build 8207: -0.008%
Covered Lines: 5794
Relevant Lines: 5976
💛 - Coveralls

dzhavat
dzhavat reviewed Mar 15, 2019
View reviewed changes
Copy link
Contributor

@dzhavat dzhavat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I'm making this comments as a fellow contributor. The approval (and merging) of this PR doesn't depend on me :)

src/internal/operators/switchMap.ts Outdated Show resolved Hide resolved
src/internal/operators/switchMap.ts Outdated Show resolved Hide resolved
src/internal/operators/switchMap.ts Show resolved Hide resolved
@xuemind
updated according to suggestion
039361e 
1. mark sample code in typescript
2. space between of(1, 2, 3)
3. outputs
xuemind
xuemind commented Mar 17, 2019
View reviewed changes
Copy link
Contributor Author

@xuemind xuemind left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update the much simple sample to demonstrate usage of switchMap operator according to review suggestion.

niklas-wortmann
niklas-wortmann approved these changes Mar 18, 2019
View reviewed changes
Copy link
Member

@niklas-wortmann niklas-wortmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks a lot!

@niklas-wortmann niklas-wortmann merged commit edb69a8 into ReactiveX:master Mar 18, 2019
@xuemind
Copy link
Contributor Author

xuemind commented Mar 18, 2019

thanks very much~

@lock lock bot locked as resolved and limited conversation to collaborators Apr 17, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dzhavat dzhavat dzhavat left review comments

@niklas-wortmann niklas-wortmann niklas-wortmann approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@xuemind @rxjs-bot @coveralls @dzhavat @niklas-wortmann