Skip to content

Commit 03f52d0

Browse files
authored
A few tiny documentation fixes with regards to development (#27)
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.
1 parent 3810f7d commit 03f52d0

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

doc.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,9 @@ See the [`InsertAndWork` example] for complete code.
126126
127127
- [Work functions] for simplified worker implementation.
128128
129-
See also [developing River].
129+
# Development
130+
131+
See [developing River].
130132
131133
[`Client`]: https://pkg.go.dev/github.com/riverqueue/river#Client
132134
[`Client.InsertTx`]: https://pkg.go.dev/github.com/riverqueue/river#Client.InsertTx

docs/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,9 @@ See the [`InsertAndWork` example] for complete code.
138138

139139
- [Work functions] for simplified worker implementation.
140140

141-
See also [developing River].
141+
## Development
142+
143+
See [developing River].
142144

143145
[`Client`]: https://pkg.go.dev/github.com/riverqueue/river#Client
144146
[`Client.InsertTx`]: https://pkg.go.dev/github.com/riverqueue/river#Client.InsertTx

docs/development.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
# River
1+
# River development
22

3-
River is an experimental Postgres queue for Go.
4-
5-
## Development
6-
7-
### Run tests
3+
## Run tests
84

95
Raise test databases:
106

@@ -14,13 +10,13 @@ Run tests:
1410

1511
go test ./... -p 1
1612

17-
### Run lint
13+
## Run lint
1814

1915
Run the linter and try to autofix:
2016

2117
golangci-lint run --fix
2218

23-
### Generate sqlc
19+
## Generate sqlc
2420

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

0 commit comments

Comments
 (0)