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

Update hello-world.md #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion by-example/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func main() {
**Notes**:

* `-c 0` argument makes the `ruleguard` print **one** context line in its output (line 6 in this example)
* `-rules` argument accepts a `ruleguard` rules source (always `rules.go` in out examples)
* `-rules` argument accepts a `ruleguard` rules source (always `rules.go` in our examples)
* [`Match()`](https://pkg.go.dev/github.com/quasilyte/go-ruleguard/dsl#Matcher.Match) argument is a [github.com/mvdan/gogrep](https://github.com/mvdan/gogrep) pattern string
* Ruleguard rules file **must** start with `package gorules`; it can't be other package
* The [`dsl`](https://pkg.go.dev/github.com/quasilyte/go-ruleguard/dsl) package documentation is a common source of the most answers
Expand Down