From b7063d6f46af712f3ea884e409a5cb8dbe505a70 Mon Sep 17 00:00:00 2001 From: Rob Bos Date: Fri, 13 Sep 2024 17:23:26 +0200 Subject: [PATCH] docs: typos (#82) Just helping out with things I noticed while getting an example to work. --- README.md | 4 ++-- dreamcode.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 25d3619..665aec8 100644 --- a/README.md +++ b/README.md @@ -402,7 +402,7 @@ await prompt({ unit: { type: "string", enum: ["c", "f"] }, }, required: ["location", "unit"], - additionalProperties: False, + additionalProperties: false, }, }, }, @@ -461,7 +461,7 @@ While implementing the lower-level functionality, we also dream big: what would ## Contributing -Please see [CONTRIBUTING.md](CONTRIBUTING.md) +Please see [CONTRIBUTING.md](CONTRIBUTING.md). ## License diff --git a/dreamcode.md b/dreamcode.md index 823dc00..3106844 100644 --- a/dreamcode.md +++ b/dreamcode.md @@ -200,7 +200,7 @@ const { isValidRequest, payload } = await copilotAgent.verifyAndParse( ## Notes -Regarding the context passed to event handlers +Regarding the context passed to event handlers: - `message` / `confirmation` / etc are objects as received by the user - `octokit` is a pre-authenticated octokit instance @@ -211,6 +211,6 @@ Regarding the context passed to event handlers - `respond` is an API to send different types of responses to the user - `log` is the logger as we use it in Octokit. See https://github.com/octokit/core.js?tab=readme-ov-file#logging -On how to receive the events (transport layer) +On how to receive the events (transport layer): - `createNodeMiddleware` is something we have currently built into some of the Octokit SDKs, e.g. https://github.com/octokit/app.js?tab=readme-ov-file#createnodemiddlewareapp-options. However, I think we will move these out into separate packages, such as `@octokit/webhooks-middleware-node`, etc. But for now, we can just assume that we ship with it by default. We can also add other middlewares for Netlify/Vercel edge functions, lambda, etc.