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

Improve Mono#share javadoc for cancelling #3741

Merged
merged 1 commit into from Mar 7, 2024

Conversation

chemicL
Copy link
Member

@chemicL chemicL commented Mar 6, 2024

Similarly to Flux#share, Mono#share also cancels the source when all Subscribers have cancelled. This change improves the documentation.

Following #2680 and #2756 there exists a misalignment in the javadoc for Mono#share method. Since cancelling the source is a fact, the javadoc is now improved instead of changing the behaviour.

Resolves #3740

@chemicL chemicL added the type/documentation A documentation update label Mar 6, 2024
@chemicL chemicL added this to the 3.4.36 milestone Mar 6, 2024
@chemicL chemicL self-assigned this Mar 6, 2024
@chemicL chemicL requested a review from a team as a code owner March 6, 2024 10:11
Similarly to Flux#share, Mono#share also cancels the source when all
Subscribers have cancelled. This change improves the documentation.

Following #2680 and #2756 there exists a misalignment in the javadoc for
Mono#share method. Since cancelling the source is a fact, the
javadoc is now improved instead of changing the behaviour.

Resolves #3740
@chemicL chemicL force-pushed the mono-share-cancellation-documentation branch from 9344e75 to f4af9da Compare March 6, 2024 10:16
@chemicL
Copy link
Member Author

chemicL commented Mar 7, 2024

Thx @violetagg !

@chemicL chemicL merged commit 3cf8977 into 3.4.x Mar 7, 2024
7 checks passed
@reactorbot
Copy link

@chemicL this PR seems to have been merged on a maintenance branch, please ensure the change is merge-forwarded to intermediate maintenance branches and up to main 🙇

chemicL added a commit that referenced this pull request Mar 7, 2024
chemicL added a commit that referenced this pull request Mar 7, 2024
@chemicL chemicL deleted the mono-share-cancellation-documentation branch March 7, 2024 09:53
@violetagg violetagg changed the title [doc] Improve Mono#share javadoc for cancelling Improve Mono#share javadoc for cancelling Mar 11, 2024
@violetagg violetagg changed the title Improve Mono#share javadoc for cancelling Improve Mono#share javadoc for cancelling Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants