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

Rename get_{sender,receiver} to new_{sender,receiver} #49

Merged
merged 1 commit into from
Nov 22, 2022

Conversation

leandro-lucarella-frequenz
Copy link
Contributor

Using get_ as a prefix gives the idea that one is always getting the same object, but these methods are indeed creating new objects.

@leandro-lucarella-frequenz leandro-lucarella-frequenz requested a review from a team as a code owner November 18, 2022 08:59
@leandro-lucarella-frequenz leandro-lucarella-frequenz added this to the v0.11.0 milestone Nov 18, 2022
@leandro-lucarella-frequenz leandro-lucarella-frequenz added the type:enhancement New feature or enhancement visitble to users label Nov 18, 2022
@github-actions github-actions bot added part:channels Affects channels implementation part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests labels Nov 18, 2022
@leandro-lucarella-frequenz leandro-lucarella-frequenz changed the title Rename get_{sender,receiver} to new_{sender,receiver} Rename get_{sender,receiver} to new_{sender,receiver} Nov 18, 2022
@leandro-lucarella-frequenz
Copy link
Contributor Author

Rebased, ping @sahas-subramanian-frequenz

shsms
shsms previously approved these changes Nov 22, 2022
Comment on lines +17 to +20
* Channels methods `get_receiver()` and `get_sender()` have been renamed to
`new_receiver()` and `new_sender()` respectively. This is to make it more
clear that new objects are being created.

Choose a reason for hiding this comment

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

Should this be listed under Breaking changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a (breaking changes) to Upgrading to make it more clear that this section list breaking changes. We can change the template if Upgrading is not clear enough. I used this to make it clear for people writing notes that it is important to say how to upgrade from breaking changes, not just listing them.

Using `get_` as a prefix gives the idea that one is always getting the
same object, but these methods are indeed creating new objects.

Signed-off-by: Leandro Lucarella <[email protected]>
@leandro-lucarella-frequenz leandro-lucarella-frequenz merged commit 7fb7cd8 into frequenz-floss:v0.x.x Nov 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:channels Affects channels implementation part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants