Commit Graph

120 Commits

Author SHA1 Message Date
Joe4evr
e30fd29085 Tweaks to audio docs (#867)
* Tweaks to audio docs

* Make it more obvious that -1 means infinity
2017-11-05 22:06:28 -05:00
enzosk8
da335b95c4 Fix general typos (#852) 2017-11-05 22:05:19 -05:00
Alex Gravely
dc151e8998 Update VS Code csproj example to target version 1.0.2. (#849)
* Update target version to 1.0.2.

* Change to target latest 1.x stable.
2017-11-05 22:05:09 -05:00
Alan Schapira
d8c4b7537b Client is global variable (#789)
In the previous section of the tutorial https://github.com/RogueException/Discord.Net/blob/dev/docs/guides/getting_started/samples/intro/client.cs, the client it a global variable with an underscore
2017-10-03 20:09:06 -04:00
Joe4evr
88c9964b54 Minor Quickstart tweaks (#783)
* 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
2017-10-03 20:07:54 -04:00
Hsu Still
22d79c1004 Improve library documentation (#826)
* 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
2017-10-03 16:48:05 -04:00
Alex Gravely
c4dcb9dc17 Update client.cs (#752)
* 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?
2017-07-16 11:33:01 -04:00
Hsu Still
b59c48b9ec Added IServiceProvider (#753) 2017-07-16 11:32:49 -04:00
Joe4evr
0bdc2455bc Add line to show subscribing to CommandService#Log (#756) 2017-07-16 11:32:31 -04:00
Alex Gravely
6e21d33999 Update events.cs
Forgot a var >_>
2017-06-20 20:44:33 -04:00
Alex Gravely
759da09c38 Update events.cs
Gladly taking suggestions for a better comments.
2017-06-19 15:21:46 -04:00
Christopher F
6ad4889a9e Merge pull request #651 from Bond-009/patch-1
Remove wrong parameter from FFMPEG audio example
2017-06-15 10:45:19 -04:00
Christopher F
699ac29ff5 Merge pull request #645 from Bond-009/patch-2
Update the example precondition to use IServiceProvider
2017-06-15 10:44:33 -04:00
Christopher F
77bf841d1d Merge pull request #669 from Bond-009/cmddocs
Update cmd docs to use IServiceProvider
2017-06-15 10:43:14 -04:00
Drew
fb01e16b36 Fixed dead link (#662)
* Update intro.md

* Update intro.md

* Update intro.md

* Update intro.md

* Update intro.md

* Update intro.md

* Update intro.md
2017-06-15 10:43:06 -04:00
Joe4evr
b0a3ce5e7c Respond to feedback. 2017-06-13 10:58:06 +02:00
Joe4evr
6cdc48bfa6 Move instructions about BuildServiceProvider() up 2017-06-07 04:32:59 +02:00
Joe4evr
12acfec1db Respond to feedback 2017-06-04 23:44:39 +02:00
Joe4evr
d05191ed05 Added/clarified some comments in structure.cs 2017-05-30 17:54:32 +02:00
Bond_009
892eca39fd Update cmd docs to use IServiceProvider 2017-05-24 21:05:06 +02:00
Christopher F
3fb661a33a fix docs compile issue 2017-05-21 14:55:47 -04:00
Joe4evr
af5fdec486 Update the quickstart structure to rc3. 2017-05-13 03:15:55 +02:00
Bond-009
a92c27da3b Remove wrong parameter from FFMPEG audio example
This parameter was samples per frame but changed to bitrate. (1920 is a way to low bitrate :) )
2017-05-11 18:01:39 +02:00
Bond-009
a1a90ae46e Update the example precondition to use IServiceProvider 2017-05-06 11:33:33 +02:00
Christopher F
d189bb9748 Expose the 'fields' collection on EmbedBuilder (#603)
* remove tip in docs about SocketEntity.Discord

* Expose the 'Fields' collection on EmbedBuilder

After some discussion I decided that there was really no reason to keep this private, and it didn't really go along with the rest of the design of the EmbedBuilder.

This is NOT a breaking change.

Exposing this property should not have any negative effects.

* Don't allow EmbedBuilder's Fields to be set to null
2017-05-04 12:53:40 -03:00
Benjamin
c7ea29f1f0 Added Jetbrains Rider installing guide 2017-04-18 19:51:29 +02:00
Christopher F
3a60c58697 Rewrite all concepts documentation
hello RC documentation
2017-04-03 18:46:00 -04:00
Christopher F
5ade1e387b Restructure documentation layout 2017-04-03 16:37:44 -04:00
Christopher F
b4c3427ed1 Deleted FAQ
this is sloppy and doesn't properly explain anything
2017-04-03 16:26:58 -04:00
Christopher F
b3c6a06500 Revamp docs page on logging 2017-04-03 16:26:29 -04:00
Christopher F
df673e02e5 Coerce docfx into building API documentation
Temporary fix while waiting on dotnet/docfx#1254
2017-04-03 15:51:17 -04:00
Christopher F
506b4ff36a Merge pull request #571 from LeafyDev/patch-1
Update audio_ffmpeg.cs
2017-03-14 15:38:47 -04:00
Christopher F
afdea0cec8 Merge pull request #572 from Bond-009/patch-2
Fixed the example precondition attribute
2017-03-14 15:38:28 -04:00
Bond-009
22f5e8ff46 Fixed the example precondition attribute 2017-03-14 20:10:37 +01:00
William Haskell
ab43f82771 Update audio_ffmpeg.cs
AudioApplication is a required argument
2017-03-14 18:47:28 +01:00
Bond-009
59a530fe1c Add installing with nuget using VSC to guides 2017-03-13 17:02:39 +01:00
Christopher F
d111214bff Added new getting started guide
Thanks @MinnDevelopment for his awesome work on
the JDA guide that had no influence here at all.
2017-03-11 15:32:14 -05:00
Christopher F
bea5e37db8 Add installing guide
🥄 better docs soon come
2017-03-10 20:38:55 -05:00
Joe4evr
4b4506f243 ConnectAsync -> StartAsync 2017-03-07 17:19:51 +01:00
Christopher F
3c9704c822 Merge pull request #520 from james7132/property-injection
Conflicts:
	docs/guides/samples/dependency_module.cs
	src/Discord.Net.Commands/Utilities/ReflectionUtils.cs
2017-02-23 15:51:24 -05:00
Christopher F
87f404c23b Move logging lambda to its own method 2017-02-21 16:36:06 -05:00
Christopher F
c1a5960116 Merge pull request #495 from Flamanis/dev
Conflicts:
	docs/guides/samples/logging.cs
Update logging.cs
2017-02-21 16:34:30 -05:00
Christopher F
061935cc9f Clean up #501 2017-02-21 16:29:40 -05:00
Christopher F
68eeb63127 Merge pull request #501 from khionu/patch-1
Update home page on docs
2017-02-21 16:27:14 -05:00
Christopher F
a110c862f6 Merge pull request #503 from Joe4evr/DocSamples
Update doc samples
2017-02-21 16:24:35 -05:00
Joe4evr
f4918c793b Add comment about message cache 2017-02-21 06:06:06 +01:00
james7132
29261a943a Fix typo 2017-02-15 21:44:31 +00:00
RyadaProductions
e3d31c5bd1 Update status.cs
SetStatus and SetGame don't exist, only SetStatusAsync and SetGameAsync
2017-02-15 13:26:25 +01:00
james7132
9609520a53 Remove "Get" statement from example docs 2017-02-11 20:12:53 +00:00
james7132
bb95686078 Update docs to reflect the change. 2017-02-10 22:11:06 +00:00