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

Outdated operator-creation.md doc #4574

Closed
1 of 5 tasks
martinsik opened this issue Feb 16, 2019 · 4 comments
Closed
1 of 5 tasks

Outdated operator-creation.md doc #4574

martinsik opened this issue Feb 16, 2019 · 4 comments
Labels
docs Issues and PRs related to documentation

Comments

@martinsik
Copy link
Contributor

Documentation Related To Component:

/doc/operator-creation.md

Please check those that apply

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

Description Of The Issue

There's one outdated document at /doc/operator-creation.md. It was last updated on Dec 15th 2017 and still recommends patching Observable.prototype. Someone on StackOverflow mentioned that when you google for "rxjs custom operator" this is the first result.

It seems like most of its content is already covered in https://github.com/ReactiveX/rxjs/blob/master/doc/pipeable-operators.md#build-your-own-operators-easily.

@niklas-wortmann
Copy link
Member

So in the new docs we have the guides about operators in general, see https://github.com/ReactiveX/rxjs/blob/master/docs_app/content/guide/operators.md#creating-custom-observables. I just took a quick look at the content of this chapter and it looks quite good for me. If you have any suggestions to improve this, just let me know

@niklas-wortmann niklas-wortmann added the docs Issues and PRs related to documentation label Mar 7, 2019
@martinsik
Copy link
Contributor Author

I was mostly concerned about this part: https://github.com/ReactiveX/rxjs/blob/master/doc/operator-creation.md#adding-the-operator-to-observable

It mentions for example this which is obsolete now:

Patch Observable.prototype directly:
Observable.prototype.mySimpleOperator = mySimpleOperator;

@benlesh
Copy link
Member

benlesh commented May 27, 2021

#5592 deals with this.

@jakovljevic-mladen
Copy link
Member

The entire /doc folder is removed with the PR #5338. The content of that folder was used for the old docs site. It is now replaced with the new app which is located under /docs_app folder. Much like @niklas-wortmann said in this comment, the guide for creating custom operators is now moved to this file: /docs_app/content/guide/operators.md.

That file does not mention anything related to the problem described in this issue, so I'm gonna close this as outdated. Thanks for reporting.

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

4 participants