Documentation December Update #1218
Conversation
| var result = await _commands.ExecuteAsync(context, argPos, _services); | ||
| if (result.CommandError != null) | ||
| switch(result.CommandError) | ||
| { | ||
| case CommandError.BadArgCount: | ||
| await context.Channel.SendMessageAsync("Parameter count does not match any command's."); | ||
| await context.Channel.SendMessageAsync( | ||
| "Parameter count does not match any command's."); |
There was a problem hiding this comment.
| "Parameter count does not match any command's."); | |
| "Parameter count does not match any commands."); |
There was a problem hiding this comment.
Commands' makes sense though, since we are comparing the command parameter count against the command's parameter count.
src/Discord.Net.Core/Entities/Channels/GuildChannelProperties.cs
Outdated
Show resolved
Hide resolved
src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs
Outdated
Show resolved
Hide resolved
src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs
Outdated
Show resolved
Hide resolved
src/Discord.Net.Core/Entities/Channels/TextChannelProperties.cs
Outdated
Show resolved
Hide resolved
Still34
force-pushed
the
docs/12-21-18Update
branch
from
e5aa96f
to
5fb6ba5
Compare
|
I've been having trouble implementing the logos into our current docs setup. Particularly, fitting the logo SVG to replace the DocFX one, as well as putting the logo on the frontpage while complying with the themes (might need js help on this one). I won't have much time until mid-January, so help would be appreciated. |
|
I found that the DocFX logo was just 38pt by 38pt which perfectly fit into the navbar. I've branched from commit 5fb6ba5 and implemented logo support in this PR here: Still34#14 |
+ Add GetPermission sample + Add ModifyAsync remarks
+ Add ModifyAsync remarks + Add GetOverwritePermissionAsync examples
+ Add example, remarks for Get(Default)AvatarUrl + Add example, remarks for GetOrCreateDMChannelAsync + Add missing remarks/summary/returns for other properties of the class
+ Add remarks/example to the class + Add remarks to AlwaysDownloadUsers
This should drastically improve docfx build time.
Improve performance
+ Rewritten .NET Core deployment strategies for better clarification
* Split deployment types into framework-dependent and self-contained
* Clarify the benefits of using different types of publishing
* Include a sample of how to execute dotnet application with the dotnet command in a TIP dialog for visibility
+ This change is to reflect changes made in discord-net#1164, where CommandInfo is now passed into the CommandExecuted event as an Optional<T>
* Fix incorrect Optional<T> usage * Indent some sample code and add a comment reminding the user that the post-execution basic sample code is not ideal.
+ This commit also adds further explanation for why Embeds and Attachments are read-only collections
This is done by changing the documentation of the implementations required by interfaces to redirect to the interface method instead (e.g., SocketDMChannel#GetMessagesAsync refer to IMessageChannel.GetMessagesAsync within the remarks of the method).
Co-Authored-By: Still34 <341464@gmail.com>
Co-Authored-By: Still34 <341464@gmail.com>
Co-Authored-By: Still34 <341464@gmail.com>
Co-Authored-By: Still34 <341464@gmail.com>
* Reword sentences of deployment article for clarification & remove mention of portability * Fix typos/grammar errors within TextChannelProperties
Still34
force-pushed
the
docs/12-21-18Update
branch
from
ff26464
to
24534b8
Compare
|
Docs logo issue resolved. Thanks, @Chris-Johnston! If nothing else, the PR should be ready to be merged. Before then, additional reviews would be appreciated. |
| This will create a package with dependencies compiled for the target | ||
| platform, meaning that all the required dependencies will be included | ||
| with the program. This will result in **larger package size**; | ||
| however, that means the copy of the runtime that can be run |
There was a problem hiding this comment.
Seems like there's a bit more removed here than should've been? At the very least, it doesn't read right.
There was a problem hiding this comment.
I tried to reword the original sentence but nothing sounded right. Some suggestions would be great.
|
The logo on the front page has some issues on certain browsers when specifying the background image with css it seems: at least when using
Possibly related StackOverflow. Edit: A fix has been proposed in Still34#15 |
Summary
This documentation update includes everything that has been changed since #1161 hosted on the pre-release documentation.
Notable Changes
build-1041IGuildUser,IGuildChannel,IVoiceState,IUser,DiscordSocketConfig,GuildChannelProperties,TextChannelPropertiesDirection.Around's unimplemented natureDocFX.Plugins.LastModifiedandDocFX.Plugins.DescriptionGeneratorto improve doc build performance