Correct some typos/mistakes in comments/docs #88446
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pxsalehi
added
>non-issue
:Distributed Indexing/Distributed
elasticmachine
added
the
Team:Distributed (Obsolete)
Collaborator
|
Pinging @elastic/es-distributed (Team:Distributed) |
pxsalehi
commented
Jul 11, 2022
| * | ||
| * <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} |
Member
Author
There was a problem hiding this comment.
I believe this was a mistake. @original-brownbear, could you please confirm that?
Contributor
There was a problem hiding this comment.
++ right this changed eventually and the docs here became outdated.
Contributor
original-brownbear
left a comment
original-brownbear
left a comment
There was a problem hiding this comment.
Looks good with one exception. Thanks @pxsalehi !
| * either {@code SUCCESS}, {@code FAILED} or {@code MISSING}, the {@code SnapshotsService} will update the state of the {@code Entry} | ||
| * 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.</li> |
Contributor
There was a problem hiding this comment.
This sentence was intentional duplication/repetition actually. This was to convey that the snapshot is finalized as far as files/blobs in the repository are concerned.
If we want to change this, it'd be nice to retain that meaning.
Member
Author
There was a problem hiding this comment.
I see! I added it back but not in the same place! Please see e90e51e.
| * | ||
| * <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} |
Contributor
There was a problem hiding this comment.
++ right this changed eventually and the docs here became outdated.
original-brownbear
approved these changes
Jul 11, 2022
idegtiarenko
approved these changes
Jul 12, 2022
Member
Author
|
Thank you, Armin and Ievgen! |
weizijun
added a commit
to weizijun/elasticsearch
that referenced
this pull request
Jul 12, 2022
* upstream/master: Pass IndexMetadata to AllocationDecider.can_remain (elastic#88453) [TSDB] Cache rollup bucket timestamp to reduce rounding cost (elastic#88420) Correct some typos/mistakes in comments/docs (elastic#88446) Make ClusterInfo use immutable maps in all cases (elastic#88447) Reduce map lookups (elastic#88418) Don't index geo_shape field in AbstractBuilderTestCase (elastic#88437) Remove usages of TestGeoShapeFieldMapperPlugin from enrich module (elastic#88440) Fix test memory leak (elastic#88362) Improve error when sorting on incompatible types (elastic#88399) Remove usages of BucketCollector#getLeafCollector(LeafReaderContext) (elastic#88414) Mute ReactiveStorageIT::testScaleWhileShrinking (elastic#88431) Clarify snapshot docs on archive indices (elastic#88417) [Stack Monitoring] Switch cgroup memory fields to keyword (elastic#88260) Fix RealmIdentifier XContent parser (elastic#88410) Make LoggedExec gradle task configuration cache compatible (elastic#87621) Update CorruptedFileIT so that it passes with new allocation strategy (elastic#88314) Update RareClusterStateIT to work with the new shards allocator (elastic#87922) Ensure CreateApiKey always creates a new document (elastic#88413) # Conflicts: # x-pack/plugin/rollup/src/main/java/org/elasticsearch/xpack/rollup/v2/RollupShardIndexer.java
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.