-
Notifications
You must be signed in to change notification settings - Fork 61
docs(operators): add documentation for operator empty #147
Conversation
|
Thx @grumblerchester! |
Codecov Report
@@ Coverage Diff @@
## master #147 +/- ##
==========================================
- Coverage 91.02% 88.46% -2.57%
==========================================
Files 7 7
Lines 78 78
Branches 5 7 +2
==========================================
- Hits 71 69 -2
Misses 6 6
- Partials 1 3 +2
Continue to review full report at Codecov.
|
src/operator-docs/creation/empty.ts
Outdated
| extras: [ | ||
| { | ||
| type: 'Tip', | ||
| text: `Just emits 'complete', and nothing else.` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this comes from the rxjs 5 docs but I believe this could cause confusion. To me a beginner may think this actually emits the string 'complete' and not understand the complete notification.
For instance, if I'm a new user and read this:
Just emits 'complete', and nothing else.
Then look above:
Creates an Observable that emits no items
This could be frustrating. Is there a way we can enhance the wording here? Or maybe this one is better without the extra tip?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove the tip indeed @btroncone to avoid confusion as you mentioned.
xlozinguez
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove tip for this operator as it is not providing additional value and introduces confusion
|
@grumblerchester - Could please update the commit message and PR title to be
|
|
Rebased and updated according to comments. |
|
@grumblerchester Please rebase. |
Add initial version of documentation for creation operator 'empty'.
|
@sumitarora The code is rebased now. |
|
thx @grumblerchester! great PR! :) |
Add initial version of documentation for creation operator 'empty'.
closes #76