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

Mark CSOT feature as Alpha #1372

Merged
merged 15 commits into from May 3, 2024
Merged

Mark CSOT feature as Alpha #1372

merged 15 commits into from May 3, 2024

Conversation

vbabanin
Copy link
Member

@vbabanin vbabanin commented Apr 20, 2024

Description

This PR designates the CSOT API as Alpha for experimental use.

Additionally, it introduces the Alpha annotation. While initially utilized within the CSOT API, the annotation's Javadoc covers broader context beyond CSOT.

JAVA-5402

@vbabanin vbabanin requested a review from stIncMale April 20, 2024 00:51
@vbabanin vbabanin changed the base branch from master to CSOT April 20, 2024 00:51
@vbabanin vbabanin requested a review from jyemin April 20, 2024 00:51
@vbabanin vbabanin changed the title Introduce Alpha annotation Mark CSOT feature as Alpha Apr 22, 2024
3) The following files: Beta.java, UnsignedLongs.java, UnsignedLongsTest.java
3) The following files:

Alpha.java (formerly Beta.java)
Copy link
Member Author

@vbabanin vbabanin Apr 22, 2024

Choose a reason for hiding this comment

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

The documentation in Alpha.java references Javadoc wording from our Beta annotation, which itself incorporates wording from Guava's Beta.java. Because of this transitive relationship: Alpha -> Beta -> Guava's Beta, copyright for Alpha.java was added here.

@vbabanin vbabanin marked this pull request as ready for review April 22, 2024 01:53
@vbabanin vbabanin self-assigned this Apr 22, 2024
Copy link
Contributor

@jyemin jyemin left a comment

Choose a reason for hiding this comment

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

Looking good.

I noted a few missing annotations on getTimeout methods, but please double-check that they are all annotated.

@vbabanin vbabanin requested a review from jyemin April 22, 2024 20:55
Copy link
Contributor

@jyemin jyemin left a comment

Choose a reason for hiding this comment

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

LGTM

- Mode Reason to top-level class.
- Change JavaDoc of Alpha annotation for better accuracy.

JAVA-5402
# Conflicts:
#	driver-reactive-streams/src/main/com/mongodb/reactivestreams/client/AggregatePublisher.java
#	driver-reactive-streams/src/main/com/mongodb/reactivestreams/client/DistinctPublisher.java
JAVA-5402
@vbabanin vbabanin requested a review from stIncMale April 26, 2024 21:01
vbabanin and others added 2 commits May 1, 2024 14:55
Co-authored-by: Valentin Kovalenko <valentin.male.kovalenko@gmail.com>
- Mark timeoutMode with Alpha annotation

JAVA-5402
README.md Outdated Show resolved Hide resolved
JAVA-5402
@vbabanin vbabanin requested a review from stIncMale May 2, 2024 21:14
@vbabanin vbabanin merged commit 2fdae3b into mongodb:CSOT May 3, 2024
52 of 58 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants