From a5ae8ae6c09b9fb127dd9f85e8f2f2c7995d11d7 Mon Sep 17 00:00:00 2001 From: Brandur Date: Mon, 13 Nov 2023 18:44:13 -0800 Subject: [PATCH] A few tiny documentation fixes with regards to development 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. --- doc.go | 4 +++- docs/README.md | 4 +++- docs/development.md | 12 ++++-------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc.go b/doc.go index bc0a1dc9..5cf56c27 100644 --- a/doc.go +++ b/doc.go @@ -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 diff --git a/docs/README.md b/docs/README.md index 1bf788e5..64c9a796 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/docs/development.md b/docs/development.md index 9a98db16..aa5ed01d 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,10 +1,6 @@ -# River +# River development -River is an experimental Postgres queue for Go. - -## Development - -### Run tests +## Run tests Raise test databases: @@ -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: