Skip to content

Commit f2011ab

Browse files
committed
📝 format notes in README
1 parent 9e6a61f commit f2011ab

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

readme.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,9 @@ properly. These are:
188188
- `bot`: The Discord bot instance.
189189
- `config`: The configuration dictionary for the extension.
190190

191-
> [!NOTE] Either `setup` or `setup_webserver` is required for the extension to work
191+
<!-- prettier-ignore -->
192+
> [!NOTE]
193+
> Either `setup` or `setup_webserver` is required for the extension to work
192194
> properly. You can also provide both.
193195

194196
- `on_startup` (optional): An asynchronous function that is called when the bot starts.
@@ -271,7 +273,9 @@ strings:
271273
# ... other general strings
272274
```
273275

274-
> [!NOTE] The top-level `strings` section (outside of `commands`) is what gets mapped to
276+
<!-- prettier-ignore -->
277+
> [!NOTE]
278+
>The top-level `strings` section (outside of `commands`) is what gets mapped to
275279
> `config["translations"]`. This section is for general strings not directly tied to
276280
> specific commands.
277281

@@ -331,7 +335,9 @@ async def ping(self, ctx: custom.ApplicationContext):
331335
await ctx.respond(response)
332336
```
333337

334-
> [!NOTE] The translations available under `ctx.translations` are the ones set under
338+
<!-- prettier-ignore -->
339+
> [!NOTE]
340+
> The translations available under `ctx.translations` are the ones set under
335341
> `strings` in the command's translation.
336342

337343
### Best Practices

0 commit comments

Comments
 (0)