This repository has been archived by the owner on Sep 9, 2020. It is now read-only.
gps: improve documentation; add package doc #1619
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmank88
commented
Feb 2, 2018
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| // Package gps is a Go packaging solver library. |
There was a problem hiding this comment.
Embedding code examples here could get pretty dense, but maybe this should point to example.go at least (especially since it doesn't show up in the go doc as a runnable example).
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this do / why do we need it?
This PR improves and adds
package gpsdocumentation, based on scanning through the godoc.What should your reviewer look out for in this PR?
Do you need help or clarification on anything?
Should links to https://github.com/sdboyer/gps/wiki be forwarded elsewhere? Or is that still the best resource?
Which issue(s) does this PR fix?
Towards #672.