daemon/graphdriver/btrfs fix lint errors/warnings#14875
Conversation
|
LGTM |
daemon/graphdriver/btrfs/btrfs.go
Outdated
There was a problem hiding this comment.
What kinds of statuses? How may they be used? Are there any caveats?
There was a problem hiding this comment.
@stevvooe There is no plural here. It is as simple as returning a status. Can you elaborate?
There was a problem hiding this comment.
How is a slice of statuses not plural?
Based on the method name, we know it returns status. This is a specific implementation for btrfs, so certain statuses may be returned. What are they? What do they mean? How can they be used? Are there caveats?
The proposed documentation provides absolutely no benefit to the reader of the code.
There was a problem hiding this comment.
Well I can say a K-V pair that contains "Build Version" and "Library Version" but then we are documenting content of the return? Not sure what caveats you see, can you clarify?
There was a problem hiding this comment.
@brahmaroutu The point of godoc is to provide a lost developer with a hint about the value using a particular method. With stringly typed data on an implementation, documenting the return value is completely valid. In this case, the method always returns the same values, since it is specific to the btrfs driver.
A good approach might be to give guidance on the meaning of "Build Version" and "Library Version" and how they can be used. Are they simply informational or can they be used to infer supported features?
3d1d2ef to
c1c8417
Compare
Addresses moby#14756 Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
c1c8417 to
17c19f3
Compare
|
LGTM |
daemon/graphdriver/btrfs fix lint errors/warnings
Addresses #14756
Signed-off-by: Srini Brahmaroutu srbrahma@us.ibm.com