Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add awaits and missing imports in usage examples #2860

Merged
merged 7 commits into from Jul 14, 2019

Conversation

Jackenmen
Copy link
Member

@Jackenmen Jackenmen commented Jul 13, 2019

Type

  • Bugfix
  • Enhancement
  • New feature

Description of the changes

Well, the modlog examples had to be changed a lot, because await obviously won't work in regular method. I used the same way as it's done in core code.

@Jackenmen Jackenmen changed the title [Docs] Add awaits in bank's usage example [Docs] Add awaits in usage examples Jul 13, 2019
@Jackenmen Jackenmen changed the title [Docs] Add awaits in usage examples [Docs] Add awaits and missing imports in usage examples Jul 13, 2019
- Cogs should inherit from `commands.Cog`
- `modlog.create_case()` should take the bot as its first argument, and doesn't require the `until` or `channel` arguments
- It's better style, and more reliable, to use an asynchronous `initialize()`, method than it is to spawn a background task on load.
- Casetypes should use actual UTF-8 characters where possible since `:emoji:` doesn't get rendered in embeds

Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
@mikeshardmind mikeshardmind added the Category: Docs - Other This is related to documentation that doesn't have its dedicated label. label Jul 14, 2019
@Tobotimus Tobotimus merged commit 3e80edc into Cog-Creators:V3/develop Jul 14, 2019
@Tobotimus Tobotimus added this to the 3.1.3 milestone Jul 14, 2019
@Jackenmen Jackenmen deleted the patch-1 branch July 16, 2019 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Docs - Other This is related to documentation that doesn't have its dedicated label.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants