+ Rename Guides.Concepts.Logging title from 'Logging' to 'Logging Events/Data'.
+ Rewrite various sections of Guides.GettingStarted.FirstBot and Guides.GettingStarted.Installing based on suggested changes from #1027.
+ Rename project.csproj example to project.xml to avoid auto-compilation from Visual Studio Code.
+ Rename 'samples\intro' to 'samples\first-bot' to reflect on the article name change.
+ Clean first-bot samples.
This change is because how our repo and project namespace uses .Net instead of .NET.
For consistency sake, we should refer to the project as Discord.Net.
commit 5b047bf02b
Author: Joe4evr <jii.geugten@gmail.com>
Date: Fri Feb 2 22:22:00 2018 +0100
[feature/OnModuleAdded] Quickstart fixes (#946)
* Quickstart: fix minor derp
* Other overdue fixes
commit bd3e9eee94
Author: Christopher F <computerizedtaco@gmail.com>
Date: Sat Jan 27 16:51:18 2018 -0500
Resort usings in ModuleBase
commit 8042767579
Author: Christopher F <computerizedtaco@gmail.com>
Date: Sat Jan 27 16:41:39 2018 -0500
Clean up removed owned IServiceProvider
commit 30066cb102
Author: Christopher F <computerizedtaco@gmail.com>
Date: Sat Jan 27 16:37:22 2018 -0500
Remove redundant try-catch around OnModuleBuilding invocation
If this exception is going to be rethrown, there's no reason to include
a try-catch.
commit 60c7c31d44
Author: Christopher F <computerizedtaco@gmail.com>
Date: Sat Jan 27 16:36:27 2018 -0500
Include the ModuleBuilder in OnModuleBuilding
This allows modules hooking into OnModuleBuilding method to mutate
theirselves at runtime.
commit b6a9ff5786
Author: Joe4evr <jii.geugten@gmail.com>
Date: Mon Jan 22 13:17:14 2018 +0100
#DERP
commit f623d19c68
Author: Joe4evr <jii.geugten@gmail.com>
Date: Mon Jan 22 13:15:31 2018 +0100
Resolution for #937 because it's literally 4 lines of code
commit 8272c9675b
Author: Joe4evr <jii.geugten@gmail.com>
Date: Mon Jan 22 11:39:28 2018 +0100
Re-adjust quickstart
commit e30b907135
Author: Joe4evr <jii.geugten@gmail.com>
Date: Mon Jan 22 11:35:08 2018 +0100
Undo experimental changes, request IServiceProvider instance everywhere instead
commit ad7e0a46c8
Author: Joe4evr <jii.geugten@gmail.com>
Date: Fri Jan 19 03:40:27 2018 +0100
Fix quickstart leftover from previous draft
commit e3349ef3d4
Author: Joe4evr <jii.geugten@gmail.com>
Date: Fri Jan 19 03:33:46 2018 +0100
Doc comment on items
commit 81bd9111fa
Author: Joe4evr <jii.geugten@gmail.com>
Date: Fri Jan 19 03:16:44 2018 +0100
Add comment about the ServiceProviderFactory in the quickstart
commit 72b5e6c8a1
Author: Joe4evr <jii.geugten@gmail.com>
Date: Fri Jan 19 03:10:40 2018 +0100
Remove superfluous comments, provide simpler alternative for setting the ServiceProvider.
commit 74b17b0e04
Author: Joe4evr <jii.geugten@gmail.com>
Date: Tue Jan 16 18:06:28 2018 +0100
Experimental change for feedback
commit 7b100e99bb
Author: Joe4evr <jii.geugten@gmail.com>
Date: Mon Jan 15 23:34:06 2018 +0100
* Make the service provider parameters required
* Adjust quickstart guide to reflect changes
commit 7f1b792946
Author: Joe4evr <jii.geugten@gmail.com>
Date: Mon Jan 15 20:04:37 2018 +0100
I..... missed one.
commit 031b289d80
Author: Joe4evr <jii.geugten@gmail.com>
Date: Mon Jan 15 20:02:20 2018 +0100
Rename method to more intuitive 'OnModuleBuilding'
commit 9a166ef1d0
Author: Joe4evr <jii.geugten@gmail.com>
Date: Mon Jan 15 19:09:10 2018 +0100
Add callback method for when a module class has been added to the CommandService.
* Remove saving Console.ForegroundColor to a local
* Add message handler checks
* Add comment explaining that there's two differently named methods to add modules
* Add comment about the Commands package
* Add Exception property to log handler
* Improve the Command Service documentation
The following changes have been added to this PR:
• Fix minor grammatical errors.
• Capitalize terms such as Commands, Modules and such, as the context is specific to the lib.
• Wrap methods and properties in code blocks.
The docs page currently has several issues that remains to be fixed.
1.
```md
>[!WARNING]
>This article is out of date and has not been rewritten yet.
Information is not guaranteed to be accurate.
```
The docs doesn't necessarily seem "out of date" as the warning claims. The basics seem pretty relevant to the latest version of the lib.
2.
>“To manually load a module, invoke [CommandService.AddModuleAsync], by passing in the generic type of your module and optionally, a dependency map.”
The latter part of the sentence seems off. Where should the user pass the dependency map to? It seems to suggest that `AddModuleAsync` has an argument to pass the dependency to. If it is referring to `AddModuleAsync(Type type)`, then I feel like it should be clarified here - or perhaps change the wording of the sentence.
3.
>“First, you need to create an @System.IServiceProvider You may create your own IServiceProvider if you wish.”
Any mention of @System.IServiceProvider is currently broken on the docs.
4.
>“Submodules are Modules that reside within another one. Typically, submodules are used to create nested groups (although not required to create nested groups).”
Clarification on the part after "although?"
5.
>“Finally, pass the map into the LoadAssembly method. Your modules will automatically be loaded with this dependency map.”
Where is this `LoadAssembly` method?
6.
```md
>[!NOTE]
>Preconditions can be applied to Modules, Groups, or Commands.
```
The docs should mention `ParameterPreconditionAttribute`'s existence.
* Update line breaks to comply with docs standard
* Change "you should..." to "instead, ..."
* Trim trailing spaces
* Change "inherits" to "inherit"
* Fix Context warning note and add ReplyAsync xref
* Fix broken xrefs
* Fix [Command Service] xref
* Fix consistency between TypeReaders and Preconditions returns
* Add missing semi-colons in ServiceProvider sample
* Change CommandContext to SocketCommandContext & change variable naming
* Cleanup TypeReader section
* Wrap [DontInject] in code block
* Fix commands docs linking in intro
* Improve Getting Started - Installation
- Fix character misalignment to comply with docs standard.
- Fix image numbering issues by moving the tooltips above some of the steps.
- Add codeblocks to search terms like `Discord.Net`.
- Remove broken `addons` reference.
- Specify `.NET 4.6.1` as `.NET Framework 4.6.1`.
- Minor cross-reference cleanup.
* Fix Getting Started - Intro
- Minor grammartical fixes.
- Wrap mentions of the methods, properties, and events in code block.
- Replace `Discord.Net` to `Discord.NET`.
- Fix steps numbering under `Creating a Discord Bot` and `Adding your bot to a server`.
- Change `Task-based Asynchronous Pattern ([TAP])` linking to mark the entire term instead.
- Change code block of `Pong!` to quotation mark instead.
* Fix cross references in Sending Voice
* Mention parameter precondition attribute
* Change `Discord.NET` to `Discord.Net` for consistency
* Wrap project names in code blocks & minor fixes in Terminology
* Change `add-ons` to `addons` for consistency
* Fix cross references in Logging
* Fix minor grammatical issues in "Working with Events"
* Missed a tilda
* Remove out-of-date warning in Commands
* Minor grammatical fixes for Entities
* Fix broken xref in Logging
* Adjust service collection sample
...according to f89aecb7bf (r141530227)
* Update Command Handler sample
- Update Main for C# 7.1.
- Inject CommandService and DiscordSocketClient into the service collection.
- Add Async suffix to asynchronous methods.
* Minor grammatical fixes in Events
* Revert 2 incorrect grammar corrections
* Revert async Main sample
* Add hardcode token notice in sample
* Fix missing method for Command Handler
* Modify module samples to use SocketCommandContext instead
* Emphasize CommandContext and SocketCommandContext
* Fix formatting for module sample
* Add SocketCommandContext for Groups sample
* Remove comma
* Fix DepMap sample formatting
* Replace [DontInject] with DontInjectAttribute with cross reference
* Remove connection logic note
There is no reason that this note should still be here since Ready event exists.
* Add a new warning message informing the users the existence of CommandService
* Make command handler private
excellent change
* Update client.cs
Let's not have the client be a local variable, hm?
* Update complete.cs
* Update complete.cs
* Update client.cs and complete.cs
Let's not have the client be a local variable, hm?
Still Hsu
Christopher F
Joe4evr
enzosk8
Alex Gravely
Alan Schapira
Drew