documentation: fix typo in RegisterCodec godoc #5306
Conversation
modify Compressors to Codecs
| @@ -108,7 +108,7 @@ var registeredCodecs = make(map[string]Codec) | |||
| // more details. | |||
| // | |||
| // NOTE: this function must only be called during initialization time (i.e. in | |||
| // an init() function), and is not thread-safe. If multiple Compressors are | |||
| // an init() function), and is not thread-safe. If multiple Codecs are | |||
There was a problem hiding this comment.
This doesn't seem like the right change. This is to register codecs, not compressors.
There was a problem hiding this comment.
Line 72 is the same as line 111. I think line 72 is right, but the comment is for RegisterCodec(...) in line111.
And like you said "This is to register codecs, not compressors." so, the comment should be changed codecs?
There was a problem hiding this comment.
Line 72 is for function RegisterCompressor, and line 111 is for RegisterCodec
There was a problem hiding this comment.
However, it seem like we can register compressors to RegisterCodec according to the unmodified comments.
Actually we can only register codecs to RegisterCodec according to the code.
There was a problem hiding this comment.
Ohhhh, sorry. I see. I read it wrong.
Yeah this look like the right fix. Thanks for the change!
| @@ -108,7 +108,7 @@ var registeredCodecs = make(map[string]Codec) | |||
| // more details. | |||
| // | |||
| // NOTE: this function must only be called during initialization time (i.e. in | |||
| // an init() function), and is not thread-safe. If multiple Compressors are | |||
| // an init() function), and is not thread-safe. If multiple Codecs are | |||
There was a problem hiding this comment.
Ohhhh, sorry. I see. I read it wrong.
Yeah this look like the right fix. Thanks for the change!
menghanl
changed the title
modify Compressors to Codecs
RELEASE NOTES: None