Skip to content
This repository was archived by the owner on Jul 7, 2024. It is now read-only.

Commit

Permalink
docs: jsdoc doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
zleyyij committed Sep 10, 2023
1 parent 010caba commit f41b44b
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ docker-docs: docs
# --rm removes the container once it's finished running,
# -d means to run in daemon mode, -p 8080:80 indicates that we want to
# take port 80 inside the container and map it to port 8080 on the outside
docker run --rm -d -p 8080:80 turingdocs
docker run --rm -d -p 8080:80 --name turingdocs turingdocs
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A scaleable Discord bot, built as a replacement for https://github.com/r-Techsupport/TechSupportBot

## Important documentattion
## Important documentation

1) Startup environment guides
- Prod environment setup (TODO)
Expand Down
2 changes: 1 addition & 1 deletion src/core/modules.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export interface ModuleInputOption {
* options.filter(option => option.startsWith(value)).map(option => {name: option, value: option});
* ```
*
* @doc https://discordjs.guide/slash-commands/autocomplete.html#responding-to-autocomplete-interactions
* @see https://discordjs.guide/slash-commands/autocomplete.html#responding-to-autocomplete-interactions
*/
autocomplete?: (
currentlyTyped: string
Expand Down
6 changes: 3 additions & 3 deletions src/core/permissions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -360,12 +360,12 @@ export function checkInteractionAgainstPermissionConfig(

// someone should clean this up if they feel so inclined, i think you could nest a lot less deeply
/**
* @param interaction The interaction to check against the context block
* @param contextBlock The block to check when comparing against the interaction
* @returns A context block, where any key that's set is the key the check caught,
* Returns a context block, where any key that's set is the key the check caught,
* and the value is the same as the context block passed in the function declaration. So if you
* passed an interaction where the user id was "foo", and the {@link ContextBlock} had "foo" in the list of users,
* the returned value would look like `{ users: ['foo'] }`
* @param interaction The interaction to check against the context block
* @param contextBlock The block to check when comparing against the interaction.
*/
function checkContextBlockForInteraction(
interaction: ChatInputCommandInteraction,
Expand Down

0 comments on commit f41b44b

Please sign in to comment.