Skip to content

daemon/graphdriver/btrfs fix lint errors/warnings#14875

Merged
jessfraz merged 1 commit intomoby:masterfrom
brahmaroutu:lint_daemon_graphdriver_btrfs
Jul 27, 2015
Merged

daemon/graphdriver/btrfs fix lint errors/warnings#14875
jessfraz merged 1 commit intomoby:masterfrom
brahmaroutu:lint_daemon_graphdriver_btrfs

Conversation

@brahmaroutu
Copy link
Contributor

Addresses #14756
Signed-off-by: Srini Brahmaroutu srbrahma@us.ibm.com

@calavera
Copy link
Contributor

LGTM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What kinds of statuses? How may they be used? Are there any caveats?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevvooe There is no plural here. It is as simple as returning a status. Can you elaborate?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

@brahmaroutu brahmaroutu force-pushed the lint_daemon_graphdriver_btrfs branch from 3d1d2ef to c1c8417 Compare July 23, 2015 20:53
Addresses moby#14756
Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
@brahmaroutu brahmaroutu force-pushed the lint_daemon_graphdriver_btrfs branch from c1c8417 to 17c19f3 Compare July 23, 2015 22:49
@jessfraz
Copy link
Contributor

LGTM

jessfraz pushed a commit that referenced this pull request Jul 27, 2015
daemon/graphdriver/btrfs fix lint errors/warnings
@jessfraz jessfraz merged commit 303345d into moby:master Jul 27, 2015
@brahmaroutu brahmaroutu deleted the lint_daemon_graphdriver_btrfs branch August 12, 2015 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants