docs(general): clarify introduction section #5419
Conversation
| @@ -22,7 +22,7 @@ To import only what you need using pipeable operators: | |||
| import { of } from 'rxjs'; | |||
| import { map } from 'rxjs/operators'; | |||
|
|
|||
| of(1,2,3).pipe(map(x => x + '!!!')); // etc | |||
| of(1,2,3).pipe(map(x => x + '!!!')); | |||
There was a problem hiding this comment.
Hi there. There is an empty space left after ; which might be removed. The other one couple of lines below is removed.
There was a problem hiding this comment.
thanks for spotting this
docs_app/content/guide/overview.md
Outdated
|
|
||
| What makes RxJS powerful is its ability to produce values using pure functions. That means your code is less prone to errors. | ||
| This is only an example demonstrating the behavior of reactive programming. |
There was a problem hiding this comment.
This file has also couple of empty spaces at the end of some lines. If this is not important, please let me know, I won't report it anymore.
There was a problem hiding this comment.
I don't have really strong opinions about that. IMO it helps maintaining the markdown file
There was a problem hiding this comment.
I kinda don't like empty spaces at the end of lines, they look a bit dirty to me. But if they can help, sure, keep having them.
niklas-wortmann
force-pushed
the
docs/clarification
branch
from
6852048
to
e439e6f
Compare
| @@ -29,13 +29,13 @@ const observer = { | |||
| }; | |||
| ``` | |||
|
|
|||
| When subscribing to an Observable, you may also just provide the callbacks as arguments, without being attached to an Observer object, for instance like this: | |||
| When subscribing to an Observable, you can also provide the callbacks as anonymous function, without wrapping it in an object: | |||
There was a problem hiding this comment.
Whether or not you pass an anonymous function to the argument, does not matter, i don't think. https://stackblitz.com/edit/rxjs-ftnxyh
Could we consider rewording to "you can pass references to callback functions as the arguments"?
There was a problem hiding this comment.
good point. Thanks a lot for your input on that. Happy to use this wording
|
@niklas-wortmann we need to think of a way to merge this work with the work I'm doing over on #5592 |
|
@benlesh as #5592 is going in master and will therefore be the updated docs for v7 and upcoming I would suggest moving this to the v6 branch to add some clarifications there. Now that I see the merge conflicts I will probably create a new pr branching of v6. I will just keep this open in the meantime to have the changes visible :D |
|
Core Team: this goes to v6 docs. |
|
Looks like this needs rebased. |
|
closed by #5871 |
I started to go over the general information section to remove some technical bla bla. It aims to make it easier for the reader to understand the important concepts and focus on the relevant parts!
Additionally, I slightly changed the sidebar and split the guides in an "Essential" and an "Advanced" section. We could add a small paragraph somewhere describing this structure to give an overview, but I think for now I can imagine this to help people to get into this by focusing on the essentials. At the same time, I split some larger sections into multiple smaller one and put them in the related category. E.g. the former
operatorsguide is split intooperators,marble diagrams&higher-order Observables