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: add deprecation notes to documentation pages #6379

Merged
merged 1 commit into from May 7, 2021

Conversation

tmair
Copy link
Contributor

@tmair tmair commented May 7, 2021

Description:
This PR adds deprecation notes to the documentation for single method and function overrides. Additionally a strikethrough is also added to the method signature. The source of the changes was the angular.io project, although only the pieces necessary for the deprecations where included.

There are still some places that are a little odd:

  • if all function overloads are deprecated, the deprecation note is shown for the function and all of its overloads
  • if all function overloads are marked as deprecated the function is not marked with a deprecated badge
  • the deprecation notes contain literal links to http://rxjs.dev/... Their purpose is probalby to accomodate IDEs to show the correct link

I am planing on working on some of the issues above in follow up PRs to keep this one simple as I think that this PR already adds value to the documentation.

Examples:
toPromise method
grafik
grafik

pluck function
grafik
grafik

publishReplay function
grafik
grafik

Related issue (if exists):
#5404

@benlesh
Copy link
Member

benlesh commented May 7, 2021

This looks awesome!

cc @niklas-wortmann

Copy link
Member

@niklas-wortmann niklas-wortmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's an awesome contribution. Many thanks for that

@niklas-wortmann niklas-wortmann merged commit 53ef494 into ReactiveX:master May 7, 2021
@tmair tmair deleted the deprecations-docs branch May 7, 2021 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants