github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Docs] Fix inline code blocks and misc tweaks. (#2878)

Browse Source 
* Fix code blocks and list items having overlap if they contain code blocks.

* Fixes for interaction framework intro guide.

* Add NuGet icon to top navbar.

* tweak action triggers

* Fix mobile navbar links.

* Add relatively ugly hack to improve toc filter functionality.

---------

Co-authored-by: Mihail Gribkov <61027276+Misha-133@users.noreply.github.com>
This commit is contained in:
Nora
2024-03-15 06:02:25 +01:00
committed by GitHub
parent 4efe3be301
commit 3331614a7a
4 changed files with 83 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/guides/int_framework/intro.md
View File

@@ -30,8 +30,8 @@ A new module instance is created before a command execution starts then it will
Every module class must:
- be public
- inherit [InteractionModuleBase]
- Be public
- Inherit from [InteractionModuleBase]
Optionally you can override the included :
@@ -61,7 +61,7 @@ Valid **Interaction Commands** must comply with the following requirements:
|[Autocomplete Command](#autocomplete-commands)| `Task`/`Task<RuntimeResult>` | - | - | `[AutocompleteCommand]`|
> [!NOTE]
> a `TypeConverter` that is capable of parsing type in question must be registered to the [InteractionService] instance.
> A `TypeConverter` that is capable of parsing type in question must be registered to the [InteractionService] instance.
> You should avoid using long running code in your command module.
> Depending on your setup, long running code may block the Gateway thread of your bot, interrupting its connection to Discord.
@@ -94,13 +94,17 @@ By default, your methods can feature the following parameter types:
- `sbyte`, `byte`
- `int16`, `int32`, `int64`
- `uint16`, `uint32`, `uint64`
- `enum` (Values are registered as multiple choice options and are enforced by Discord. Use the `[Hide]` attribute on enum values to prevent them from getting registered.)
- `enum`
- `DateTime`
- `TimeSpan`
> [!NOTE]
> Enum values are registered as multiple choice options and are enforced by Discord. Use the `[Hide]` attribute on enum values to prevent them from getting registered.
---
**You can use more specialized implementations of [IChannel] to restrict the allowed channel types for a channel type option.*
**You can use more specialized implementations of [IChannel] to restrict the allowed channel types for a channel type option.**
| interface | Channel Type |
|---------------------|-------------------------------|
| `IStageChannel` | Stage Channels |