Provide an example for check command#162
Conversation
|
|
||
| ```shell | ||
| go-licenses check <package> [package...] | ||
| go-licenses check <package> [package...] |
There was a problem hiding this comment.
Remove the trailing space. Github is not showing it probably because this line belongs to the same chunk as the modified lines below.
README.md
Outdated
|
|
||
| **Tip**: Usually you'll want to add | ||
|
|
||
| * `...` to check all the packages in your repository |
There was a problem hiding this comment.
make it clear add ... to package
There was a problem hiding this comment.
Hmm, but the repository root is not necessarily an importable package.
There was a problem hiding this comment.
not sure I understand your comment, as your linked doc ... means a pattern to match packages, root does not need to be a package.
There was a problem hiding this comment.
I thought you meant that I should change to "... to package (i.e., github.com/google/go-licenses) to check all the packages in your repository", but maybe I misunderstood your point.
There was a problem hiding this comment.
ohh, I was not clear. let me clarify. I think this sentence lacks some context. It does not tell where to add ...
so I am asking you to make the sentence more complete. Add description that ... is appended to the end of an import path to include all packages matching that pattern.
There was a problem hiding this comment.
Thank you for the clarification! Fixed in 1d973cb.
54398e8 to
3cc35a1
Compare
3cc35a1 to
1d973cb
Compare
Summary
PR fixes #160 (comment).
Notes
The usage of
**Tip**comes fromgo-licenses/README.md
Line 86 in 6073243
--include_testis also added because that's the very reason why I created Add include_tests flag for deps only used in tests #160, and Add include_tests flag for deps only used in tests #160 (comment) also mentions:I thought about putting this section after those of the flags (e.g.,
--disallowed_types), but I feel thatgo-licenses check --include_tests github.com/your-org/your-repo/...is potentially a template command that suits most use cases (i.e., users only need to replace the placeholders to make the command work for them), so I put it right after the intro ofcheck. No strong opinion though.