Style: improve api clients comments #780
Open
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
method is now no longer used anymore, and could be deprecated
samlaf
commented
Oct 2, 2024
| @@ -30,6 +30,7 @@ func GenericDecodeBlob(data []byte) ([]byte, error) { | |||
| if len(data) <= 32 { | |||
| return nil, fmt.Errorf("data is not of length greater than 32 bytes: %d", len(data)) | |||
| } | |||
| // TODO: why [1]? What's in [0]? | |||
There was a problem hiding this comment.
@bxue-l2 you prob know this
samlaf
commented
Oct 2, 2024
Comment on lines
+30
to
+31
| // TODO: all of these should be private, to prevent users from using them directly, | ||
| // which breaks encapsulation and makes it hard for us to do refactors or changes |
There was a problem hiding this comment.
this I personally think is a refactor worth doing... but it might break some client code... :\
samlaf
commented
Oct 2, 2024
Comment on lines
103
to
106
| if len(data) == 0 { | ||
| // TODO: explain when/why/how this can happen | ||
| return nil, fmt.Errorf("blob has length zero") | ||
| } |
There was a problem hiding this comment.
@bxue-l2 do you know?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Small improvements to comments/docs for api clients.
Had some fun in the plane while reading the code.
Added some TODOs in a few places which might be worth checking through, perhaps we can solve some of them right away @bxue-l2