Spelling #1375

jsoref · 2021-09-23T06:24:25Z

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at jsoref@25c4e10#commitcomment-56931936

The action reports that the changes in this PR would make it happy: jsoref@0882626

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

Signed-off-by: Josh Soref <[email protected]>

app-sre-bot · 2021-09-23T06:24:27Z

Can one of the admins verify this patch?

jsoref

Most corrections were selected automatically using Google Sheets, with two exceptions that I can recall

jsoref · 2021-09-23T06:24:41Z

CHANGELOG.md

@@ -647,7 +647,7 @@
 - [162e8cd](https://github.com/quay/clair/commit/162e8cdafc66be28b021f83da736a2b612ddda99): enable suse updater
 - [0609ed9](https://github.com/quay/clair/commit/0609ed964b0673806462a24147e6028da85d8a38): removed worker config
 - [af2c688](https://github.com/quay/clair/commit/af2c68863482ae9f93a2db1533be260468a6ea2d): not properly loaded error ([#140](https://github.com/quay/clair/issues/140))
- -  [#140](https://github.com/quay/clair/issues/140) - fixes [#134](https://github.com/quay/clair/issues/134)- [30055af](https://github.com/quay/clair/commit/30055af03e357b44cfbacb3088eab337a94e51e8): fallover correctly to default config
+ -  [#140](https://github.com/quay/clair/issues/140) - fixes [#134](https://github.com/quay/clair/issues/134)- [30055af](https://github.com/quay/clair/commit/30055af03e357b44cfbacb3088eab337a94e51e8): failover correctly to default config


not entirely certain

jsoref · 2021-09-23T06:24:55Z

Documentation/concepts/notifications.md

@@ -58,7 +58,7 @@ When you configure notifier for webhook delivery you provide the service with th
 When the notifier has determined an updated security database has changed the affected status of an indexed manifest, it will deliver the following JSON body to the configured target:
 ```json
 {
-  "notifiction_id": {uuid_string},


jsoref · 2021-09-23T06:25:09Z

Documentation/contribution.md

@@ -1,4 +1,4 @@
-# Contribuion


This change will break external deep links to this anchor.

That's fine, they'll end up dumped in the same spot.

jsoref · 2021-09-23T06:25:28Z

Documentation/reference/api.md

@@ -3,7 +3,7 @@ title: ClairV4 v0.1
 language_tabs:
  - python: Python
  - go: Golang
-  - javascript: Javascript
+  - javascript: JavaScript


appears harmless

jsoref · 2021-09-23T12:42:03Z

Documentation/reference/config.md

@@ -564,7 +564,7 @@ An address in `<host>:<post>` syntax where traces can be submitted.
 #### `$.trace.jaeger.collector.username`
 a string value

-#### `$.trace.jaeger.collector.passwordd`
+#### `$.trace.jaeger.collector.password`


This is a noteworthy bug fix

jsoref · 2021-09-23T12:44:43Z

notifier/mockstore.go

+	Notifications_       func(ctx context.Context, id uuid.UUID, page *Page) ([]Notification, Page, error)
+	PutNotifications_    func(ctx context.Context, opts PutOpts) error
+	PutReceipt_          func(ctx context.Context, updater string, r Receipt) error
+	DeleteNotifications_ func(ctx context.Context, id uuid.UUID) error


Go tends to insist on this sort of alignment change

jsoref · 2021-09-23T12:45:14Z

notifier/postgres/e2e_test.go

 	}
 	if !cmp.Equal(receipt.Status, notifier.Created) {
 		t.Fatal(cmp.Diff(receipt.Status, notifier.Delivered))
 	}

 	receipt, err = e.store.ReceiptByUOID(e.ctx, e.updateID)
 	if err != nil {
-		t.Fatalf("failed to retrieve receipt by OUID")


In my and Louis' defense, it's extremely easy to both typo and mentally transpose "uo".

Yeah, typos happen, that's why I work on a spell checker that helps catch things like this.

Fwiw, overall, this project's typo count is pretty low.

jsoref · 2021-09-23T12:45:55Z

notifier/service/testmode.go

@@ -49,10 +49,10 @@ func indexerForTestMode(mock *indexer.Mock) {
 // MatcherForTestMode configures a mock Matcher service for notifier test mode.
 //
 // in notifier test mode a notifier.Poller will request "matcher.LatestUpdateOperations" at which point
-// a new UO pair will be smithed.


I'm curious about this word choice

jsoref · 2021-09-23T12:46:18Z

notifier/store.go

-// Notificationer implements persistence methods for Notification models
-type Notificationer interface {
+// Notifier implements persistence methods for Notification models
+type Notifier interface {


jsoref · 2021-09-23T12:46:42Z

openapi.yaml

@@ -466,7 +466,7 @@ components:
          example: |-
            sha256:35c102085707f703de2d9eaad8752d6fe1b8f02b5d2149f1d8357c9cc7fb7d0a
        reason:
-          description: "the reason for the notifcation, [added | removed]"
+          description: "the reason for the notification, [added | removed]"


Developer facing?

yes, needs the generate script run to rebuild the served schema.

hdonnay

🙏🙏🙏
This is very cool.

The changes to CHANGELOG.md are a nonstarter, as it's autogenerated. Those typos are actually in the git commit messages. Beyond that, this all looks about right.

Would you mind me taking this and combining commits, making some needed code changes, etc. over the next week or so?

hdonnay · 2021-09-23T14:59:16Z

Documentation/contribution.md

@@ -1,4 +1,4 @@
-# Contribuion


That's fine, they'll end up dumped in the same spot.

hdonnay · 2021-09-23T15:02:00Z

middleware/introspection/instrumentedhandler.go

@@ -1,4 +1,4 @@
-package instrospection
+package introspection


That's a sign nothing is actually using anything defined in this file. That's alarming.

hdonnay · 2021-09-23T15:03:51Z

notifier/postgres/e2e_test.go

 	}
 	if !cmp.Equal(receipt.Status, notifier.Created) {
 		t.Fatal(cmp.Diff(receipt.Status, notifier.Delivered))
 	}

 	receipt, err = e.store.ReceiptByUOID(e.ctx, e.updateID)
 	if err != nil {
-		t.Fatalf("failed to retrieve receipt by OUID")


In my and Louis' defense, it's extremely easy to both typo and mentally transpose "uo".

hdonnay · 2021-09-23T15:04:39Z

notifier/service/testmode.go

@@ -49,10 +49,10 @@ func indexerForTestMode(mock *indexer.Mock) {
 // MatcherForTestMode configures a mock Matcher service for notifier test mode.
 //
 // in notifier test mode a notifier.Poller will request "matcher.LatestUpdateOperations" at which point
-// a new UO pair will be smithed.


hdonnay · 2021-09-23T15:05:37Z

openapi.yaml

@@ -466,7 +466,7 @@ components:
          example: |-
            sha256:35c102085707f703de2d9eaad8752d6fe1b8f02b5d2149f1d8357c9cc7fb7d0a
        reason:
-          description: "the reason for the notifcation, [added | removed]"
+          description: "the reason for the notification, [added | removed]"


yes, needs the generate script run to rebuild the served schema.

jsoref

Please be my guest. And thanks.

jsoref · 2021-09-23T16:19:35Z

middleware/introspection/instrumentedhandler.go

@@ -1,4 +1,4 @@
-package instrospection
+package introspection


🤷‍♀️

I'll leave that concern to you folks

jsoref · 2021-09-23T16:23:37Z

notifier/postgres/e2e_test.go

 	}
 	if !cmp.Equal(receipt.Status, notifier.Created) {
 		t.Fatal(cmp.Diff(receipt.Status, notifier.Delivered))
 	}

 	receipt, err = e.store.ReceiptByUOID(e.ctx, e.updateID)
 	if err != nil {
-		t.Fatalf("failed to retrieve receipt by OUID")


Yeah, typos happen, that's why I work on a spell checker that helps catch things like this.

Fwiw, overall, this project's typo count is pretty low.

jsoref added 30 commits September 23, 2021 00:15

spelling: associated

b508531

Signed-off-by: Josh Soref <[email protected]>

spelling: confirms

f770eaf

Signed-off-by: Josh Soref <[email protected]>

spelling: constructor

344c512

Signed-off-by: Josh Soref <[email protected]>

spelling: contain

01f574e

Signed-off-by: Josh Soref <[email protected]>

spelling: contribution

a9530f0

Signed-off-by: Josh Soref <[email protected]>

spelling: created

df8296f

Signed-off-by: Josh Soref <[email protected]>

spelling: current

c32672c

Signed-off-by: Josh Soref <[email protected]>

spelling: database

f75bd10

Signed-off-by: Josh Soref <[email protected]>

spelling: deferred

7b0ecb5

Signed-off-by: Josh Soref <[email protected]>

spelling: delivered

4b2249b

Signed-off-by: Josh Soref <[email protected]>

spelling: deserialization

2c17a77

Signed-off-by: Josh Soref <[email protected]>

spelling: destination

aff5627

Signed-off-by: Josh Soref <[email protected]>

spelling: diagnostics

d3ef82f

Signed-off-by: Josh Soref <[email protected]>

spelling: diagram

5b2c020

Signed-off-by: Josh Soref <[email protected]>

spelling: dockerfile

1dfaefb

Signed-off-by: Josh Soref <[email protected]>

spelling: failover

08e89cc

Signed-off-by: Josh Soref <[email protected]>

spelling: http

7b75081

Signed-off-by: Josh Soref <[email protected]>

spelling: indicates

d785cc2

Signed-off-by: Josh Soref <[email protected]>

spelling: inited

e5ff8e8

Signed-off-by: Josh Soref <[email protected]>

spelling: introspection

4188d0c

Signed-off-by: Josh Soref <[email protected]>

spelling: javascript

79e1ae7

Signed-off-by: Josh Soref <[email protected]>

spelling: mandatory

2ab7cac

Signed-off-by: Josh Soref <[email protected]>

spelling: matcher

2a9b5e3

Signed-off-by: Josh Soref <[email protected]>

spelling: notification

7bc3f7f

Signed-off-by: Josh Soref <[email protected]>

spelling: notifications

52b04eb

Signed-off-by: Josh Soref <[email protected]>

spelling: notifier

7e600b8

Signed-off-by: Josh Soref <[email protected]>

spelling: occurred

a87859c

Signed-off-by: Josh Soref <[email protected]>

spelling: operations

8e50f9a

Signed-off-by: Josh Soref <[email protected]>

spelling: opportunistic

2a477e8

Signed-off-by: Josh Soref <[email protected]>

spelling: password

2db3e1c

Signed-off-by: Josh Soref <[email protected]>

jsoref added 18 commits September 23, 2021 00:37

spelling: performs

faf1efc

Signed-off-by: Josh Soref <[email protected]>

spelling: protocol

13829e5

Signed-off-by: Josh Soref <[email protected]>

spelling: provided

cdf1a8b

Signed-off-by: Josh Soref <[email protected]>

spelling: representing

e845a85

Signed-off-by: Josh Soref <[email protected]>

spelling: responsible

c22a00c

Signed-off-by: Josh Soref <[email protected]>

spelling: retrieve

e2ad9c0

Signed-off-by: Josh Soref <[email protected]>

spelling: retrieving

6c6c3e4

Signed-off-by: Josh Soref <[email protected]>

spelling: semantics

355ee3a

Signed-off-by: Josh Soref <[email protected]>

spelling: serialization

c84dbe7

Signed-off-by: Josh Soref <[email protected]>

spelling: successful

8e025b3

Signed-off-by: Josh Soref <[email protected]>

spelling: transaction

627d450

Signed-off-by: Josh Soref <[email protected]>

spelling: unify

790ac14

Signed-off-by: Josh Soref <[email protected]>

spelling: unintended

6d113f6

Signed-off-by: Josh Soref <[email protected]>

spelling: unprivileged

8ee4393

Signed-off-by: Josh Soref <[email protected]>

spelling: uoid

9d012bd

Signed-off-by: Josh Soref <[email protected]>

spelling: update

765d63e

Signed-off-by: Josh Soref <[email protected]>

spelling: version

b84dd70

Signed-off-by: Josh Soref <[email protected]>

spelling: vulnerabilities

e698321

Signed-off-by: Josh Soref <[email protected]>

jsoref requested a review from a team as a code owner September 23, 2021 06:24

jsoref requested review from hdonnay and removed request for a team September 23, 2021 06:24

jsoref commented Sep 23, 2021

View reviewed changes

hdonnay reviewed Sep 23, 2021

View reviewed changes

jsoref commented Sep 23, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spelling #1375

Spelling #1375

jsoref commented Sep 23, 2021

app-sre-bot commented Sep 23, 2021

jsoref left a comment

jsoref Sep 23, 2021

jsoref Sep 23, 2021

jsoref Sep 23, 2021

hdonnay Sep 23, 2021

jsoref Sep 23, 2021

jsoref Sep 23, 2021

jsoref Sep 23, 2021

jsoref Sep 23, 2021

hdonnay Sep 23, 2021

jsoref Sep 23, 2021

jsoref Sep 23, 2021

hdonnay Sep 23, 2021

jsoref Sep 23, 2021

jsoref Sep 23, 2021

hdonnay Sep 23, 2021

hdonnay left a comment

hdonnay Sep 23, 2021

hdonnay Sep 23, 2021

hdonnay Sep 23, 2021

hdonnay Sep 23, 2021

hdonnay Sep 23, 2021

jsoref left a comment

jsoref Sep 23, 2021

jsoref Sep 23, 2021

Spelling #1375

Are you sure you want to change the base?

Spelling #1375

Conversation

jsoref commented Sep 23, 2021

app-sre-bot commented Sep 23, 2021

jsoref left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hdonnay left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment