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]: Rename/Aliasing the combineAll operator to combineLatestAll #4590

Closed
BioPhoton opened this issue Feb 25, 2019 · 6 comments
Closed

[docs]: Rename/Aliasing the combineAll operator to combineLatestAll #4590

BioPhoton opened this issue Feb 25, 2019 · 6 comments
Assignees
Labels
AGENDA ITEM Flagged for discussion at core team meetings

Comments

@BioPhoton
Copy link
Contributor

Current Behavior
All good! Just the naming might be confusing.

Possible Solution
I would expect the name of combineAll to be combineLatestAll.

Additional context/Screenshots
If you take a look to the "naming convention" you will realize that all the other operators like switchAll, mergeAll, zipAll etc. process higher order observables and follow the patterns [operatorName]All.

Therefore I consider the naming as inconsistent. For me it implies a different behavior.

I would suggest to implement it as an alias.

@kwonoj
Copy link
Member

kwonoj commented Feb 25, 2019

combineLatest operator does different to combine does. How does combinelatestAll matches semantics to combine behavior?

@BioPhoton
Copy link
Contributor Author

As far as I know, there is no combine operator. Please correct me if I'm wrong.

Let me reference the docs to give a more tangible input why I believe the renaming makes sense:
combineAll

@kwonoj
Copy link
Member

kwonoj commented Feb 25, 2019

Yes, there isn't combine operator. My q is if combineAll goes combineLatestAll, it'll not be aligned with existing combineLatest operator.

I am not necessarily agreed your argument: internally it calls combineLatest yes, but it's special kind of projection and not transparent forwarding to combineLatest.

Also worth note we are trying to reduce alias at all cost, not expanding it. We have observed amount of confusion by one operator have different names and do not want to bring additional.

@BioPhoton
Copy link
Contributor Author

BioPhoton commented Feb 25, 2019

Thanks for further elaboration @kwonoj I appreciate that you take you time!

Here is a overview that shows the foundation for my suggestion of renaming combineAll as well as exhaustAll #4573.

It's a naming matrix for operators.
rxjs-operator-naming-matrix
It should be obvious to realize the system behind it...

Regarding aliases:

Also worth note we are trying to reduce alias at all cost, not expanding it. We have observed the amount of confusion by one operator have different names and do not want to bring additional.

I would suggest a renaming in version 7 as there are anyway breaking changes.
We could easily include these changes in a tool like rxjs-tslint and do the renaming automatically.


In my opinion consistency in naming is most important to learn all the different operators. I have even more suggestions that would fix inconsistencies in naming and would help people to learn.

If there is Interest cc @benlesh @cartant @jwo719 I can try to deliver a fully fledged suggestion for consistent naming of all operators in the next 2-3 weeks.

As I said, creating a naming matrix and have consistent naming would help the community a lot in learning.
In every training, the feedback from my attendees is the same regarding operator naming and grouping of operators. It's just feedback from approximately 400 - 500 people but I guess worth to at least have a think about...

@BioPhoton
Copy link
Contributor Author

Another reason why renaming/aliasing should be doable:
#3927
It's done anyway a lot...

@BioPhoton BioPhoton changed the title Shouldn't the combineAll operator be named combineLatestAll [docs]: Rename/Aliasing the combineAll operator to combineLatestAll Mar 29, 2019
@benlesh benlesh added the AGENDA ITEM Flagged for discussion at core team meetings label Feb 20, 2021
@benlesh
Copy link
Member

benlesh commented Feb 24, 2021

From core team meeting: We should alias combineAll as combineLatestAll and deprecate the old one.

@benlesh benlesh self-assigned this Feb 24, 2021
cartant added a commit to cartant/rxjs that referenced this issue Mar 5, 2021
@benlesh benlesh closed this as completed in 42cee80 Mar 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AGENDA ITEM Flagged for discussion at core team meetings
Projects
None yet
Development

No branches or pull requests

3 participants