Skip to content

Correct some typos/mistakes in comments/docs #88446

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.

Sign up for GitHub

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 2 commits into from
Jul 12, 2022
Merged

Correct some typos/mistakes in comments/docs #88446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27e4d51
Correct some typos/mistakes in comments/docs
pxsalehi Jul 4, 2022
e90e51e
Address review comments
pxsalehi Jul 11, 2022
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 server/src/main/java/org/elasticsearch/action/support/ListenableActionFuture.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import java.util.List;

/**
* A {@code Future} and {@link ActionListener} against which which other {@link ActionListener}s can be registered later, to support
* A {@code Future} and {@link ActionListener} against which other {@link ActionListener}s can be registered later, to support
* fanning-out a result to a dynamic collection of listeners.
*/
public class ListenableActionFuture<T> extends AdapterActionFuture<T, T> {
Expand Down
2 changes: 1 addition & 1 deletion server/src/main/java/org/elasticsearch/snapshots/RestoreService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1307,7 +1307,7 @@ public ClusterState execute(ClusterState currentState) {
// that will be opened by the restore
if (currentIndexMetadata == null) {
// Index doesn't exist - create it and start recovery
// Make sure that the index we are about to create has a validate name
// Make sure that the index we are about to create has a valid name
ensureValidIndexName(currentState, snapshotIndexMetadata, renamedIndexName);
shardLimitValidator.validateShardLimit(snapshotIndexMetadata.getSettings(), currentState);

Expand Down
4 changes: 2 additions & 2 deletions server/src/main/java/org/elasticsearch/snapshots/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@
* {@code UpdateIndexShardSnapshotStatusRequest}.</li>
*
* <li>If as a result of the received status update requests, all shards in the cluster state are in a completed state, i.e are marked as
* either {@code SUCCESS}, {@code FAILED} or {@code MISSING}, the {@code SnapshotShardsService} will update the state of the {@code Entry}
* either {@code SUCCESS}, {@code FAILED} or {@code MISSING}, the {@code SnapshotsService} will update the state of the {@code Entry}
Copy link
Member Author

Choose a reason for hiding this comment

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

I believe this was a mistake. @original-brownbear, could you please confirm that?

Copy link
Contributor

Choose a reason for hiding this comment

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

++ right this changed eventually and the docs here became outdated.

* itself and mark it as {@code SUCCESS}. At the same time {@link org.elasticsearch.snapshots.SnapshotsService#endSnapshot} is executed,
* writing the metadata necessary to finalize the snapshot in the repository to the repository.</li>
* writing to the repository the metadata necessary to finalize the snapshot in the repository.</li>
*
* <li>After writing the final metadata to the repository, a cluster state update to remove the snapshot from the cluster state is
* submitted and the removal of the snapshot's {@code SnapshotsInProgress.Entry} from the cluster state completes the snapshot process.
Expand Down