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 documentation for platform options and expose to Godoc #266

Merged
merged 1 commit into from
Jun 10, 2021

Conversation

djdv
Copy link
Contributor

@djdv djdv commented Apr 12, 2021

KeyValue's documentation says "See platform docs for more details.", but I didn't see any in Godoc.

When looking through the source I found a helpful table, but it was not being exposed to the documentation generator.
Some of the platform specific options were missing as well.

I moved the table so that godoc associates it with KeyValue, and filled in the platform blanks I found.
(I think it's all of them, but I'm not positive)

In addition, I noticed UserService is checked on more platforms than just OS X. So I moved it to the POSIX section.
I considered moving some of the POSIX options out to the Linux section since they're only checked there, but figured platform support may be added for them later. So I kept them as is.

There's also some minor linter complaints addressed in the comments like adding periods, and a small spelling correction.
These can be split out or removed from the patch if desired.

This is how things are rendering for my local instance:
2021-04-12 17 33 07 j desk top 3e276e435e75

compared to the current release:
https://pkg.go.dev/github.com/kardianos/service@v1.2.0#Config
+
https://pkg.go.dev/github.com/kardianos/service@v1.2.0#KeyValue

@coveralls
Copy link

coveralls commented Apr 12, 2021

Coverage Status

Coverage remained the same at 12.799% when pulling 58ccf27 on djdv:add/docs into ef35c56 on kardianos:master.

@djdv
Copy link
Contributor Author

djdv commented Apr 13, 2021

(Force pushed over a typo I missed "reaload" -> "reload")

@kardianos kardianos merged commit 8eb6809 into kardianos:master Jun 10, 2021
@djdv djdv deleted the add/docs branch July 22, 2021 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants