Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add godocs to to the types lib #62

Merged
merged 3 commits into from
Aug 12, 2019

Conversation

fearful-symmetry
Copy link
Contributor

This adds basic godocs to the types lib, so it at least runs linter-clean. I didn't want to do the entire codebase, as touching that much stuff in one PR is a tad annoying, IMO. I wasn't sure about about the verbiage I use for the interfaces, since the way this library uses its interface types is a little odd, as the user is expected to actively cast between interfaces.

Copy link
Member

@jsoriano jsoriano left a comment

Choose a reason for hiding this comment

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

In general it LGTM, but there is a line that seems incorrect, and I wonder if we should rephrase docs of interfaces a little bit.

types/process.go Outdated Show resolved Hide resolved
types/process.go Outdated Show resolved Hide resolved
Copy link
Member

@jsoriano jsoriano left a comment

Choose a reason for hiding this comment

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

There is one small typo, once fixed this looks good to go. Thanks!

types/process.go Outdated Show resolved Hide resolved
types/host.go Outdated Show resolved Hide resolved
@fearful-symmetry fearful-symmetry merged commit 47d3129 into elastic:master Aug 12, 2019
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.

2 participants