Skip to content

Commit 4e0a36b

Browse files
authored
[*] fix typos in docs and source comments (#1204)
- Fix "publicating" → "publishing" in log broker hook comment - Fix "deinitions" → "definitions" in config DB bootstrap doc - Fix "Exucute" → "Execute" in v2 to v3 migration guide - Remove stray single quote from connection string in Docker installation doc
1 parent 65834ca commit 4e0a36b

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/howto/config_db_bootstrap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ pgwatch --sink=postgresql://pgwatch:pgwatchadmin@localhost/measurements config i
5959
## Usage
6060

6161
You can now configure pgwatch to use the `pgwatch` database as the configuration database for storing monitored sources,
62-
metric deinitions and presets.
62+
metric definitions and presets.
6363

6464
```terminal
6565
$ pgwatch --sources=postgresql://pgwatch:pgwatchadmin@localhost/pgwatch --sink=postgresql://[email protected]/measurements

docs/howto/migrate_v2_to_v3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ from pgwatch2.monitored_db;
7373
You may skip this step if you have not created custom metrics or presets.
7474
All built-in metrics and presets are already included in pgwatch3.
7575

76-
Exucute the following queries to migrate the metrics and presets:
76+
Execute the following queries to migrate the metrics and presets:
7777

7878
```sql
7979
insert into pgwatch.preset

docs/tutorial/docker_installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Source file `sources.yaml` in the same directory:
220220

221221
```yaml
222222
- name: demo
223-
conn_str: postgresql://pgwatch:pgwatchadmin@postgres/pgwatch'
223+
conn_str: postgresql://pgwatch:pgwatchadmin@postgres/pgwatch
224224
preset_metrics: exhaustive
225225
is_enabled: true
226226
group: default

internal/log/log_broker_hook.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type MessageType string
1515
// MessageChanType represents the format of the message channel
1616
type MessageChanType chan MessageType
1717

18-
// BrokerHook is the implementation of the logrus hook for publicating logs to subscribers
18+
// BrokerHook is the implementation of the logrus hook for publishing logs to subscribers
1919
type BrokerHook struct {
2020
highLoadTimeout time.Duration // wait this amount of time before skip log entry
2121
subscribers []MessageChanType //

0 commit comments

Comments
 (0)