Remove old docs annotations #7227
Conversation
There was a problem hiding this comment.
@benlesh, I added as much comments as I could find for the easier review, but I also found a couple of other issues that could be fixed, I'll commit them later.
Also, please note that this PR fixes two issues, both of them described in the PR description. And, I really hope this is the last 100+ files changed PR from me 🤣
p.s. We now run docs generation script in the pipelines (as of #6913), therefore we're sure that these changes work and that they don't break the docs generation.
Edit: committed them with this commit.
| * @return {Observable} An Observable of projected values from the most recent | ||
| * values from each input Observable, or an array of the most recent values from | ||
| * each input Observable. | ||
| * @param args Any number of `ObservableInputs`s provided either as an array or as an object |
There was a problem hiding this comment.
There are many APIs that accept ObservableInputs now, but the docs aren't updated. This is only one of such updates where Observable has been replaced with ObservableInputs.
| * @param count The number of times the source Observable items are repeated, a count of 0 will yield | ||
| * an empty Observable. | ||
| * @param countOrConfig Either the number of times the source Observable items are repeated | ||
| * (a count of 0 will yield an empty Observable) or a {@link RepeatConfig} object. |
There was a problem hiding this comment.
Added RepeatConfig case here.
| @@ -58,7 +58,7 @@ import { createOperatorSubscriber } from './OperatorSubscriber'; | |||
| * | |||
| * @param notifier Function that receives an Observable of notifications with which a | |||
| * user can `complete` or `error`, aborting the retry. | |||
| * @return A function that returns an `ObservableInput` that mirrors the source | |||
| * @return A function that returns an Observable that mirrors the source | |||
There was a problem hiding this comment.
Operators don't return ObservableInputs, just Observables.
| * `a.pipe(withLatestFrom(b, c), map(([a1, b1, c1]) => a1 + b1 + c1))`). If this is not | ||
| * passed, arrays will be emitted on the output Observable. | ||
| * @param inputs An input Observable to combine with the source Observable. More | ||
| * than one input Observables may be given as argument. If the last parameter is |
There was a problem hiding this comment.
Tweaked a little since project parameter doesn't exist anymore in the parameter list.
jakovljevic-mladen
force-pushed
the
remove_old_docs_annotations
branch
from
33af5e1
to
d4dcd68
Compare
Thanks @benlesh! Two notes:
|
* docs: remove owner tag processor * docs: remove static tag processor * docs: remove @nocollapse tag definition * docs: remove @Class tag definition * docs: remove @constructor tag definition * docs: remove @method tag definition * docs: remove @type tag definition * docs: remove unused tag defs * docs: remove target-package * docs: remove more examples package stuff * docs: remove Catharsis types * docs: remove Angular specific stuff from docs * docs: replace "input Observables" with "ObservableInputs" (cherry picked from commit 6e3e5e4)
|
@benlesh, I managed to cherry-pick this commit to |
Description:
The main purpose of this PR is to remove old docs annotations. E.g.
From this example,
{someType}part is now removed from all@paramand@returntag definitions. The docs generator called these types the Catharsis types which may have been required by the old docs, but aren't with the Angular docs.Also, many other unused tag definitions are removed (like
@classor@nocollapse). Plus some more Angular specific stuff.Many removed items are separated by commits for easier review.
Related issue (if exists):
None.