Slightly improve documentation #493
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
README.md
Outdated
| @@ -359,6 +371,7 @@ The following descriptions provide additional elaboration on a few common parame | |||
| | `--print` | Use `mockery --print` to have the resulting code printed out instead of written to disk. | | |||
| | `--exported` | Use `mockery --exported` to generate public mocks for private interfaces. | | |||
| | `--with-expecter` | Use `mockery --with-expecter` to generate `EXPECT()` methods for your mocks. This is the preferred way to setup your mocks. | | |||
| | `--log-level` | Use `--log-level` to generate useful logs. Possible values are `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic` | | |||
There was a problem hiding this comment.
This is pretty self-explanatory from the CLI, probably unnecessary here in my view.
README.md
Outdated
| @@ -41,8 +42,14 @@ Visit the [releases page](https://github.com/vektra/mockery/releases) to downloa | |||
|
|
|||
| Use the [Docker image](https://hub.docker.com/r/vektra/mockery) | |||
|
|
|||
| Get mockery verion: | |||
There was a problem hiding this comment.
s/verion/version
Probably don't need this, docker pull is self-explanatory
README.md
Outdated
| Requirement | ||
| ----------- | ||
|
|
||
| For mockery to correctly generate mocks, the command has to be run on a module (i.e. your project has to have a go.mod file) |
There was a problem hiding this comment.
Actually, maybe this should belong as a note under the Examples section. But good call, people do get caught by this 👍🏻
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
closes #492
Type of change
Version of Golang used when building/testing:
How Has This Been Tested?
NA
Checklist