Open
Conversation
I find that it's not clear what all fields in notes mean. And more importantly, what part of `note` may be edited while it's sent from front-end to back-end to be saved. While looking at this file I decided to go over the whole file, and, looking at the source code, documents exactly what may be relevant when using the method of the NoteService. If anki accepts documentation, I'd be glad to do similar works for other proto types and files.
Collaborator
|
I prefer to document the Rust services instead, especially since we're planning to publish the crates soon: #4636 @andrewsanchez @fernandolins might have thoughts on this. |
Contributor
|
Thanks for documenting, but we would rather to document the rust code piece instead. I agree with @abdnh: we’re moving docs elsewhere, but in case of document proto code I’d keep comments short. One question: the NoteFieldsCheckResponse.State diff looks like it reassigns enum values. I didn't get why you changed it. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
I find that it's not clear what all fields in notes mean. And more importantly, what part of
notemay be edited while it's sent from front-end to back-end to be saved. While looking at this file I decided to go over the whole file, and, looking at the source code, documents exactly what may be relevant when using the method of the NoteService.If anki accepts documentation, I'd be glad to do similar works for other proto types and files.