Skip to content

Commit

Permalink
A few tiny documentation fixes with regards to development (#27)
Browse files Browse the repository at this point in the history
Follows up #21 with a few very small documentation fixes:

* Put the link to the development doc into its own section so that it
  looks less strange when following the list of features just before it.

* Promote the "development" header in the `development.md` up to h1
  since it's now a file only for development instructions. Promote all
  the other headers to h2.
  • Loading branch information
brandur authored Nov 14, 2023
1 parent 3810f7d commit 03f52d0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
4 changes: 3 additions & 1 deletion doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,9 @@ See the [`InsertAndWork` example] for complete code.
- [Work functions] for simplified worker implementation.
See also [developing River].
# Development
See [developing River].
[`Client`]: https://pkg.go.dev/github.com/riverqueue/river#Client
[`Client.InsertTx`]: https://pkg.go.dev/github.com/riverqueue/river#Client.InsertTx
Expand Down
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,9 @@ See the [`InsertAndWork` example] for complete code.

- [Work functions] for simplified worker implementation.

See also [developing River].
## Development

See [developing River].

[`Client`]: https://pkg.go.dev/github.com/riverqueue/river#Client
[`Client.InsertTx`]: https://pkg.go.dev/github.com/riverqueue/river#Client.InsertTx
Expand Down
12 changes: 4 additions & 8 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# River
# River development

River is an experimental Postgres queue for Go.

## Development

### Run tests
## Run tests

Raise test databases:

Expand All @@ -14,13 +10,13 @@ Run tests:

go test ./... -p 1

### Run lint
## Run lint

Run the linter and try to autofix:

golangci-lint run --fix

### Generate sqlc
## Generate sqlc

The project uses sqlc (`brew install sqlc`) to generate Go targets for Postgres
queries. After changing an sqlc `.sql` file, generate Go with:
Expand Down

0 comments on commit 03f52d0

Please sign in to comment.