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

Subject docs depend on deprecated operator #7311

Closed
skelly-energid opened this issue Jul 19, 2023 · 2 comments
Closed

Subject docs depend on deprecated operator #7311

skelly-energid opened this issue Jul 19, 2023 · 2 comments

Comments

@skelly-energid
Copy link

Describe the bug

The Subject docs https://rxjs.dev/guide/subject explain multicasting with reference to a deprecated multicast operator. That operator seems to be deprecated. The explanation should refer to something not deprecated instead (if the new API works the same way "under the hood").

Expected behavior

Clear docs that reference relevant further material.

Reproduction code

No response

Reproduction URL

No response

Version

latest

Environment

No response

Additional context

No response

@kwonoj
Copy link
Member

kwonoj commented Jul 20, 2023

multicast will be deprecated, not already deprecated.

export { multicast } from '../internal/operators/multicast';

@kwonoj kwonoj closed this as completed Jul 20, 2023
@skelly-energid
Copy link
Author

skelly-energid commented Jul 24, 2023

The documentation clearly carries a "DEPRECATED" label : https://rxjs.dev/api/index/function/multicast

Also, this first thing the documentation says is that it will be removed in an upcoming version.

Surely that means newcomers should not use it. Why direct newcomers to it as a comparison if they should not use it?

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

No branches or pull requests

2 participants