Browse Source

[docs] fix xrefs

tags/1.0-rc
Christopher F 8 years ago
parent
commit
d8c0f0aa4c
3 changed files with 3 additions and 3 deletions
  1. +1
    -1
      docs/CONTRIBUTING.md
  2. +1
    -1
      docs/guides/commands.md
  3. +1
    -1
      docs/guides/events.md

+ 1
- 1
docs/CONTRIBUTING.md View File

@@ -10,6 +10,6 @@ I don't really have any strict conditions for writing documentation, but just ke


### Compiling ### Compiling


Documentation is compiled into a static site using [DocFx](dotnet.github.io/docfx/). You **must** install a version of DocFx that supports .NET Core. The latest build of that is [2.1.0-cli-alpha](https://github.com/dotnet/docfx/releases/tag/v2.1.0-cli-alpha).
Documentation is compiled into a static site using [DocFx](https://dotnet.github.io/docfx/). We currently use version 2.8


After making changes, compile your changes into the static site with `docfx`. You can also view your changes live with `docfx --serve`. After making changes, compile your changes into the static site with `docfx`. You can also view your changes live with `docfx --serve`.

+ 1
- 1
docs/guides/commands.md View File

@@ -139,7 +139,7 @@ To opt a module out of auto-loading, flag it with
Invoke [CommandService.AddModulesAsync] to discover modules and Invoke [CommandService.AddModulesAsync] to discover modules and
install them. install them.


[DontAutoLoadAttribute]: Discord.Commands.DontAutoLoadAttribute
[DontAutoLoadAttribute]: xref:Discord.Commands.DontAutoLoadAttribute
[CommandService.AddModulesAsync]: xref:Discord_Commands_CommandService#AddModulesAsync_System_Reflection_Assembly_ [CommandService.AddModulesAsync]: xref:Discord_Commands_CommandService#AddModulesAsync_System_Reflection_Assembly_


#### Loading Modules Manually #### Loading Modules Manually


+ 1
- 1
docs/guides/events.md View File

@@ -17,7 +17,7 @@ To hook into events, you must be using the @Discord.WebSocket.DiscordSocketClien


Connection Events will be raised when the Connection State of your client changes. Connection Events will be raised when the Connection State of your client changes.


[DiscordSocketClient.Connected](xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_Connected) and [Disconnected](Discord_WebSocket_DiscordSocketClient_Disconnected) are raised when the Gateway Socket connects or disconnects, respectively.
[DiscordSocketClient.Connected](xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_Connected) and [Disconnected](xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_Disconnected) are raised when the Gateway Socket connects or disconnects, respectively.


>[!WARNING] >[!WARNING]
>You should not use DiscordClient.Connected to run code when your client first connects to Discord. The client has not received and parsed the READY event and guild stream yet, and will have an incomplete or empty cache. >You should not use DiscordClient.Connected to run code when your client first connects to Discord. The client has not received and parsed the READY event and guild stream yet, and will have an incomplete or empty cache.


Loading…
Cancel
Save