Match description field names to definition #806
Merged
Conversation
This file contains 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
In the description the name should match the name defined in the proto definition for better discoverability and less mental load.
👷 Deploy request for syncthing-docs pending review.Visit the deploys page to approve it
|
|
Is there anything that should be done to improve this? |
|
I think the change is fine, only cosmetic. Since this is touching a versioned protocol specification though, I'll let the other maintainers weigh in on the decision. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In the description, the field names should match the names defined in the proto definition for better discoverability and less mental load.
When trying to reading and understand the protocol it should be possible to look for the description of a field by searching the name of such a field in the document. However, at the moment, if a reader would like to find out more about the field
encryption_password_tokenthey should scroll down until they findenc pw tokenand a little extra effort is needed to ensure that this the same asencryption_password_token. By using the same name a reader can search and find the field in the document without extra scrolling.