-
Notifications
You must be signed in to change notification settings - Fork 2.5k
[BUG] Contradictory constraints highlighted in comments for snapshot name in CreateSnapshotRequest.java #6448
Description
Describe the bug
I'm a technical writer for the OpenSearch Project, and I'm currently working on writing upgrade and migration documentation for OpenSearch and Elasticsearch users. As part of this process, I'm taking a snapshot of the cluster state before changing things. While investigating the snapshot API, I came across an inconsistent comment in CreateSnapshotRequest.java:
On Line 74, the comment states:
must not start with underscore ('-')
The issue is that the example character, inside the single quotes, is a hyphen and not an underscore. While we continue to improve the documentation, we sometimes rely on reviewing the code itself, or at least comments in the code, to determine what the expected behavior is, what constraints we must observe, etc. So this "just a comment" should still be accurate.
To Reproduce
N/A - this is just a typo in a comment in a Java file
Expected behavior
The line should either read:
must not start with underscore ('_')
or...
must not start with hyphen ('-')
Plugins
Security
Screenshots
N/A
Host/Environment (please complete the following information):
N/A
Additional context
N/A