Skip to content

Fix minor typos in java comments(javadoc) and all that minor typos #996

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

Merged
merged 1 commit into from
Aug 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bson/src/main/org/bson/BsonDocumentWrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public final class BsonDocumentWrapper<T> extends BsonDocument {
private BsonDocument unwrapped;

/**
* A helper to convert an document of type Object to a BsonDocument
* A helper to convert a document of type Object to a BsonDocument
*
* <p>If not already a BsonDocument it looks up the documents' class in the codecRegistry and wraps it into a BsonDocumentWrapper</p>
*
Expand Down
2 changes: 1 addition & 1 deletion bson/src/main/org/bson/BsonTimestamp.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public BsonTimestamp() {
/**
* Construct a new instance for the given value, which combines the time in seconds and the increment as a single long value.
*
* @param value the timetamp as a single long value
* @param value the timestamp as a single long value
* @since 3.5
*/
public BsonTimestamp(final long value) {
Expand Down
2 changes: 1 addition & 1 deletion bson/src/main/org/bson/types/CodeWithScope.java
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public CodeWithScope(final String code, final Document scope) {
}

/**
* Gets the scope, which is is a mapping from identifiers to values, representing the scope in which the code should be evaluated.
* Gets the scope, which is a mapping from identifiers to values, representing the scope in which the code should be evaluated.
*
* @return the scope
*/
Expand Down
2 changes: 1 addition & 1 deletion bson/src/main/org/bson/types/Decimal128.java
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public final class Decimal128 extends Number implements Comparable<Decimal128> {
public static final Decimal128 NaN = fromIEEE754BIDEncoding(NaN_MASK, 0);

/**
* A constant holding a postive zero value of type {@code Decimal128}. It is equal to the value return by
* A constant holding a positive zero value of type {@code Decimal128}. It is equal to the value return by
* {@code Decimal128.valueOf("0")}.
*/
public static final Decimal128 POSITIVE_ZERO = fromIEEE754BIDEncoding(0x3040000000000000L, 0x0000000000000000L);
Expand Down
2 changes: 1 addition & 1 deletion driver-core/src/main/com/mongodb/BasicDBObjectBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ public BasicDBObjectBuilder add(final String key, final Object val) {
}

/**
* Creates an new empty object and inserts it into the current object with the given key. The new child object becomes the active one.
* Creates a new empty object and inserts it into the current object with the given key. The new child object becomes the active one.
*
* @param key the field name
* @return {@code this} so calls can be chained
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ public long getMaintenanceInitialDelay(final TimeUnit timeUnit) {
* Returns the time period between runs of the maintenance job.
*
* @param timeUnit the TimeUnit to use for this time period
* @return the time period between runs of the maintainance job in the given units
* @return the time period between runs of the maintenance job in the given units
*/
public long getMaintenanceFrequency(final TimeUnit timeUnit) {
return timeUnit.convert(maintenanceFrequencyMS, MILLISECONDS);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import static com.mongodb.assertions.Assertions.notNull;

/**
* An event for when the driver starts to checkout out a connection.
* An event for when the driver starts to check out a connection.
*
* @since 4.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* An asynchronous callback-based function, its synchronous counterpart is {@link Function}.
* <p>
* A asynchronous function provides no guarantee that it completes before
* An asynchronous function provides no guarantee that it completes before
* (in the happens-before order) the method {@link #apply(Object, SingleResultCallback)} completes,
* and produces either a successful or a failed result by passing it to a {@link SingleResultCallback} after
* (in the happens-before order) the function completes. That is, a callback is used to emulate both normal and abrupt completion of a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public static void enableSleepAfterCursorOpen(final long sleepMS) {
throw new IllegalStateException("Already enabled");
}
if (sleepMS <= 0) {
throw new IllegalArgumentException("sleepMS must be a postive value");
throw new IllegalArgumentException("sleepMS must be a positive value");
}
sleepAfterCursorOpenMS = sleepMS;
}
Expand All @@ -66,7 +66,7 @@ public static void enableSleepAfterCursorClose(final long sleepMS) {
throw new IllegalStateException("Already enabled");
}
if (sleepMS <= 0) {
throw new IllegalArgumentException("sleepMS must be a postive value");
throw new IllegalArgumentException("sleepMS must be a positive value");
}
sleepAfterCursorCloseMS = sleepMS;
}
Expand All @@ -81,7 +81,7 @@ public static void enableSleepAfterSessionClose(final long sleepMS) {
throw new IllegalStateException("Already enabled");
}
if (sleepMS <= 0) {
throw new IllegalArgumentException("sleepMS must be a postive value");
throw new IllegalArgumentException("sleepMS must be a positive value");
}
sleepAfterSessionCloseMS = sleepMS;
}
Expand Down