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.

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

[docs]: Suggestions for skipLast documentation improvements #4867

Open
1 of 5 tasks
BioPhoton opened this issue Jun 17, 2019 · 2 comments
Open
1 of 5 tasks

[docs]: Suggestions for skipLast documentation improvements #4867

BioPhoton opened this issue Jun 17, 2019 · 2 comments
Labels
docs Issues and PRs related to documentation

Comments

@BioPhoton
Copy link
Contributor

BioPhoton commented Jun 17, 2019

Documentation Related To Component:

The skipLast operator:
skipLast.ts

Please check those that apply

  • typo
  • documentation doesn't exist
  • documentation needs clarification
  • error(s)/adoption/updates in example
  • needs example

Description Of The Issue

The detailed description is missing. Also, the see also links are missing.
We might want to improve this to serve a better more detailed description for the community.

Description

The detailed description can be improved. Here we should include that:

  • it will always complete if the source completes
  • it errors if source raises an error

See Also

We miss the see also section completely.

A suggested list for related operators could look like this:

 * @see {@link last}
 * @see {@link skip}
 * @see {@link skipWhile}
 * @see {@link skipUntil}

In case we also want to reference take operators (which is partially the case here) we also might want to include the following operators:

 * @see {@link first}
 * @see {@link take}
 * @see {@link takeWhile}
 * @see {@link takeUntil}
 * @see {@link takeLast}
@BioPhoton
Copy link
Contributor Author

Sry, overlooked #4631 and #4696

@BioPhoton BioPhoton reopened this Jun 17, 2019
@cartant cartant added the docs Issues and PRs related to documentation label Jun 17, 2019
@hardikpthv
Copy link
Contributor

@BioPhoton, I think documentation is already updated for this one 🤔 https://rxjs.dev/api/operators/skipLast

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

3 participants