docs: add operator flag to operator functions #6563
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -56,6 +56,10 @@ label.raised, .api-header label { | |||
| &.impure-pipe { | |||
| background-color: $brightred; | |||
| } | |||
|
|
|||
| &.operator { | |||
| background-color: $brightred; | |||
There was a problem hiding this comment.
I reused the same color as in impure-pipe class - there are no impure pipes in RxJS 🙂
| @@ -26,6 +26,7 @@ <h1>{$ doc.name $}</h1> | |||
| {% if doc.experimental !== undefined %}<label class="api-status-label experimental">experimental</label>{% endif %} | |||
| {% if doc.stable !== undefined %}<label class="api-status-label stable">stable</label>{% endif %} | |||
| {% if doc.pipeOptions.pure === 'false' %}<label class="api-status-label impure-pipe">impure</label>{% endif %} | |||
There was a problem hiding this comment.
I think I will remove all Angular references like this one - there are so many of them that are so specific to Angular that they could be removed quite safely.
benlesh
approved these changes
Sep 22, 2021
|
This LGTM. I was sort of waiting for @niklas-wortmann's review though, since he owns the docs app. |
|
LGTM, this is a great idea and I like it a lot! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR adds a label to all functions that are considered as operator functions. That is, any function that is exported from
src/internal/operatorswill have this label.The processor that was created to determine if a document
isOperatordetermines this by checking if a document hasoriginalModuleand iforiginalModulestarts with'internal/operators'. This means that any exported function that is not operator that may in future come from'internal/operators'will be marked as an operator - for now, there are no such functions. But if some util (non-operator) function gets exported in future from'internal/operators', it should be moved to another place so that it doesn't get marked as operator.This is a handy addition, especially after RxJS v7.2.0 since operators are exported from
'rxjs'and many operators are now displayed on two pages (for example: http://rxjs.dev/api/operators/map and http://rxjs.dev/api/index/function/map).Some examples how this looks like (please notice URL):
zipcreation function, exported from'rxjs':Deprecated
zipoperator, exported from'rxjs/operators':Note: almost all (if not all) processors come with a
.spec.jsfile. I didn't add one with this PR as so many tests actually fail when tests are run. For this reason, I don't think those tests are really essential. If they ever become essential, I will write some.Related issue (if exists):
Somewhat #6544.