discorb 0.17.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4cee4be461c639c494c2981f65ba496a17e4336fcb440218c2a4852d375b277
-  data.tar.gz: 4e743b61201c82a387f580cc75e0fa448dd357c5b02af5339df9b950898c0c38
+  metadata.gz: 99a6cb7f4f4f1d7c657209570f1327f6a847b7d7db3fb031c645ca4b0a4464af
+  data.tar.gz: f207685f5153f73dba3c66f40aaf4ef100063f31746874d57c31b119f5fcb009
 SHA512:
-  metadata.gz: b440b0e1f9e19161b666df325e01120905c3cf7f38e45cb4c89db4c9c7273b9626a5bed8825706317a84605417ac8b0f688450378622ee188cd3307d1905e7c0
-  data.tar.gz: b6bfc1d6c2e64918d0b0a73529029c01b50b33ac399a83bf18e30ef5bc6e7eb1c458f1aec7ce607349c36c2ba1585ded988c33d0607ece6048f0da9571af334d
+  metadata.gz: bd641beb11497865a97e267ef1558d1f5162323713f623fcd5109e9e25a7bb41d25e1a59111b0c3b5dcbe43f77a54531973f5874b5d82927956a1ad5f1e4ea03
+  data.tar.gz: 8d25ed7b8604b59c4a4f3f8467a268472749ccbc010d216787091ea3da60e24e0ddde95add2dc30f6d40637650d19cd9ef22e54dc2141637ac2e96cd4d55ece1

data/.github/workflows/lint.yml

@@ -11,6 +11,4 @@ jobs:
         with:
           ruby-version: 3.0.0
       - name: rubocop
-        uses: reviewdog/action-rubocop@v2
-        with:
-          rubocop_version: 1.25
+        uses: reviewdog/action-rubocop@v2

data/.github/workflows/validate.yml

@@ -0,0 +1,21 @@
+name: Validate rbs
+on:
+  - push
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+      - name: Install collection
+        run: |
+          gem update rbs
+          bundle install
+          rbs collection install
+      - name: Validate
+        run: |
+          rbs -I sig validate
+

data/Changelog.md

@@ -4,6 +4,31 @@
 
 # Changelog
 
+## v0.19
+
+### v0.19.0
+
+- Change!: All bang methods don't have bang anymore. (ex: `Message#delete!`)
+- Add: Add `%a{pure}` annotation to rbs.
+- Add: Add low level APIs to Interaction.
+- Update: Update IDENTIFY key.
+
+## v0.18
+
+### v0.18.1
+
+- Add: Support `:length` option for `:string` type.
+- Add: Add `Interaction#app_permissions`
+- Fix: Fix typing of `:autocomplete` option.
+
+### v0.18.0
+
+- Change!: `XXX#fired_by` is now `XXX#user` or `XXX#member`.
+- Change!: `Message#to_reference` returns `Message::Reference`.
+- Change!: `TextChannel#default_auto_archive_duration` is now Integer.
+- Add: Support AutoMod.
+- Change: `discorb new` doesn't do initial commit.
+
 ## v0.17
 
 ### v0.17.1

data/Gemfile

@@ -17,6 +17,9 @@ gem "async-rspec", "~> 1.16"
 gem "parallel_tests", "~> 3.8"
 gem "rspec", "~> 3.11"
 
+# Typecheck
+gem "steep", "~> 1.1"
+
 # Other development tools
 gem "lefthook", "~> 0.7.7"
 gem "rufo", "~> 0.13.0"
@@ -29,3 +32,6 @@ group :docs, optional: true do
   gem "rubyzip", "~> 2.3"
   gem "yard", "~> 0.9.26"
 end
+
+gem "syntax_tree", "~> 2.8"
+gem "syntax_tree-rbs", "~> 0.5.0"

data/README.md

@@ -99,7 +99,8 @@ end
 client.run(ENV["DISCORD_BOT_TOKEN"])
 ```
 
-Note you must run `discorb setup` before using slash commands.
+> **Note**
+> You must run `discorb setup` before using slash commands.
 
 ## Contributing
 

data/Rakefile

@@ -232,106 +232,213 @@ namespace :document do
   end
 end
 
-desc "Generate rbs file using sord"
-task :rbs do
-  require "open3"
-  # rubocop: disable Layout/LineLength
-  type_errors = {
-    "SORD_ERROR_SymbolSymbolSymbolInteger" => "{ r: Integer, g: Integer, b: Integer}",
-    "SORD_ERROR_DiscorbRoleDiscorbMemberDiscorbPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
-    "SORD_ERROR_DiscorbRoleDiscorbMemberPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
-    "SORD_ERROR_f | SORD_ERROR_F | SORD_ERROR_d | SORD_ERROR_D | SORD_ERROR_t | SORD_ERROR_T | SORD_ERROR_R" => '"f" | "F" | "d" | "D" | "t" | "T" | "R"',
-    "SORD_ERROR_dark | SORD_ERROR_light" => '"dark" | "light"',
-    "SORD_ERROR_SymbolStringSymbolboolSymbolObject" => "String | Integer | Float",
-  }
-  # rubocop: enable Layout/LineLength
-  regenerate = ARGV.include?("--regenerate") || ARGV.include?("-r")
-
-  sh "sord gen sig/discorb.rbs --keep-original-comments --no-sord-comments" +
-     (regenerate ? " --regenerate" : " --no-regenerate")
-  base = File.read("sig/discorb.rbs")
-  base.gsub!(/\n +def _set_data: \(.+\) -> untyped\n\n/, "\n")
-  # base.gsub!(/(  )?( *)# @private.+?(?:\n\n(?=\1\2#)|(?=\n\2end))/sm, "")
-  base.gsub!(/untyped ([a-z_]*id)/, "_ToS \\1")
-  # #region rbs dictionary
-  base.gsub!(/  class Dictionary.+?end\n/ms, <<-RBS)
-  class Dictionary[K, V]
-    #
-    # Initialize a new Dictionary.
-    #
-    # @param [Hash] hash A hash of items to add to the dictionary.
-    # @param [Integer] limit The maximum number of items in the dictionary.
-    # @param [false, Proc] sort Whether to sort the items in the dictionary.
-    def initialize: (?::Hash[untyped, untyped] hash, ?limit: Integer?, ?sort: (bool | Proc)) -> void
-
-    #
-    # Registers a new item in the dictionary.
-    #
-    # @param [#to_s] id The ID of the item.
-    # @param [Object] body The item to register.
-    #
-    # @return [self] The dictionary.
-    def register: (_ToS id, Object body) -> self
-
-    #
-    # Merges another dictionary into this one.
-    #
-    # @param [Discorb::Dictionary] other The dictionary to merge.
-    def merge: (Discorb::Dictionary other) -> untyped
-
-    #
-    # Removes an item from the dictionary.
-    #
-    # @param [#to_s] id The ID of the item to remove.
-    def remove: (_ToS id) -> untyped
-
-    #
-    # Get an item from the dictionary.
-    #
-    # @param [#to_s] id The ID of the item.
-    # @return [Object] The item.
-    # @return [nil] if the item was not found.
-    #
-    # @overload get(index)
-    #   @param [Integer] index The index of the item.
-    #
-    #   @return [Object] The item.
-    #   @return [nil] if the item is not found.
-    def get: (K id) -> V?
-
-    #
-    # Returns the values of the dictionary.
-    #
-    # @return [Array] The values of the dictionary.
-    def values: () -> ::Array[V]
-
-    #
-    # Checks if the dictionary has an ID.
-    #
-    # @param [#to_s] id The ID to check.
-    #
-    # @return [Boolean] `true` if the dictionary has the ID, `false` otherwise.
-    def has?: (_ToS id) -> bool
-
-    #
-    # Send a message to the array of values.
-    def method_missing: (untyped name) -> untyped
-
-    def respond_to_missing?: (untyped name, untyped args, untyped kwargs) -> bool
-
-    def inspect: () -> untyped
-
-    # @return [Integer] The maximum number of items in the dictionary.
-    attr_accessor limit: Integer
+desc "Generate rbs file"
+namespace :rbs do
+  desc "Generate event signature"
+  task :event do
+    require "syntax_tree/rbs"
+    client_rbs = File.read("sig/discorb/client.rbs")
+    extension_rbs = File.read("sig/discorb/extension.rbs")
+    event_document = File.read("./docs/events.md")
+    voice_event_document = File.read("./docs/voice_events.md")
+    event_reference = event_document.split("## Event reference")[1]
+    event_reference += voice_event_document.split("# Voice Events")[1]
+    event_reference.gsub!(/^### (.*)$/, "")
+    events = []
+    event_reference.split("#### `")[1..].each do |event|
+      header, content = event.split("`\n", 2)
+      name = header.split("(")[0]
+      description = content.split("| Parameter", 2)[0].strip
+      parameters = if content.include?("| Parameter")
+          content.scan(/\| `(.*?)` +\| (.*?) +\| (.*?) +\|/)
+        else
+          []
+        end
+      events << {
+        name: name,
+        description: description,
+        parameters: parameters.map { |p| { name: p[0], type: p[1], description: p[2] } },
+      }
+    end
+    event_sig = +""
+    event_lock_sig = +""
+    extension_sig = +""
+    events.each do |event|
+      args = []
+      event[:parameters].each do |parameter|
+        args << {
+          name: parameter[:name],
+          type: if parameter[:type].start_with?("?")
+            parameter[:type][1..]
+          else
+            parameter[:type]
+          end.tr("{}`", "").tr("<>", "[]").gsub(", ", " | ").then do |t|
+            if event[:name] == "event_receive"
+              case t
+              when "Hash"
+                next "Discorb::json"
+              end
+            end
+            t
+          end,
+        }
+      end
+      sig = args.map { |a| "#{a[:type]} #{a[:name]}" }.join(", ")
+      tuple_sig = args.map { |a| a[:type] }.join(", ")
+      tuple_sig = "[" + tuple_sig + "]" if args.length > 1
+      tuple_sig = "void" if args.length.zero?
+      event_sig << <<~RBS
+        | (:#{event[:name]} event_name, ?id: Symbol?, **untyped metadata) { (#{sig}) -> void } -> Discorb::EventHandler
+      RBS
+      event_lock_sig << <<~RBS
+        | (:#{event[:name]} event, ?Integer? timeout) { (#{sig}) -> boolish } -> Async::Task[#{tuple_sig}]
+      RBS
+      extension_sig << <<~RBS
+        | (:#{event[:name]} event_name, ?id: Symbol?, **untyped metadata) { (#{sig}) -> void } -> void
+      RBS
+    end
+    event_sig << <<~RBS
+      | (Symbol event_name, ?id: Symbol?, **untyped metadata) { (*untyped) -> void } -> Discorb::EventHandler
+    RBS
+    event_lock_sig << <<~RBS
+      | (Symbol event, ?Integer? timeout) { (*untyped) -> boolish } -> Async::Task[untyped]
+    RBS
+    extension_sig << <<~RBS
+      | (Symbol event_name, ?id: Symbol?, **untyped metadata) { (*untyped) -> void } -> void
+    RBS
+    event_sig.sub!("| ", "  ").rstrip!
+    event_lock_sig.sub!("| ", "  ").rstrip!
+    extension_sig.sub!("| ", "  ").rstrip!
+    res = client_rbs.gsub!(/(?<=def on:\n)(?:[\s\S]*?)(?=\n\n)/, event_sig)
+    raise "Failed to generate Client#on" unless res
+
+    res = client_rbs.gsub!(/(?<=def once:\n)(?:[\s\S]*?)(?=\n\n)/, event_sig)
+    raise "Failed to generate Client#once" unless res
+
+    res = client_rbs.gsub!(/(?<=def event_lock:\n)(?:[\s\S]*?)(?=\n\n)/, event_lock_sig)
+    raise "Failed to generate Client#event_lock" unless res
+
+    res = extension_rbs.gsub!(/(?<=def event:\n)(?:[\s\S]*?)(?=\n\n)/, extension_sig)
+    raise "Failed to generate Extension.event" unless res
+
+    res = extension_rbs.gsub!(/(?<=def once_event:\n)(?:[\s\S]*?)(?=\n\n)/, extension_sig)
+    raise "Failed to generate Extension.once_event" unless res
+
+    File.write("sig/discorb/client.rbs", SyntaxTree::RBS.format(client_rbs), mode: "wb")
+    File.write("sig/discorb/extension.rbs", SyntaxTree::RBS.format(extension_rbs), mode: "wb")
   end
-  RBS
-  # #endregion
-  type_errors.each do |error, type|
-    base.gsub!(error, type)
+
+  desc "Generate rbs file using sord"
+  task :sord do
+    require "open3"
+    # rubocop: disable Layout/LineLength
+    type_errors = {
+      "SORD_ERROR_SymbolSymbolSymbolInteger" => "{ r: Integer, g: Integer, b: Integer}",
+      "SORD_ERROR_DiscorbRoleDiscorbMemberDiscorbPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
+      "SORD_ERROR_DiscorbRoleDiscorbMemberPermissionOverwrite" => "Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
+      "SORD_ERROR_f | SORD_ERROR_F | SORD_ERROR_d | SORD_ERROR_D | SORD_ERROR_t | SORD_ERROR_T | SORD_ERROR_R" => '"f" | "F" | "d" | "D" | "t" | "T" | "R"',
+      "SORD_ERROR_dark | SORD_ERROR_light" => '"dark" | "light"',
+      "SORD_ERROR_SymbolStringSymbolboolSymbolObject" => "String | Integer | Float",
+    }
+    # rubocop: enable Layout/LineLength
+    regenerate = ARGV.include?("--regenerate") || ARGV.include?("-r")
+
+    sh "sord gen sig/discorb.rbs --keep-original-comments --no-sord-comments" +
+       (regenerate ? " --regenerate" : " --no-regenerate")
+    base = File.read("sig/discorb.rbs")
+    base.gsub!(/\n +def _set_data: \(.+\) -> untyped\n\n/, "\n")
+    # base.gsub!(/(  )?( *)# @private.+?(?:\n\n(?=\1\2#)|(?=\n\2end))/sm, "")
+    base.gsub!(/untyped ([a-z_]*id)/, "_ToS \\1")
+    # #region rbs dictionary
+    base.gsub!(/  class Dictionary.+?end\n/ms, <<-RBS)
+    class Dictionary[K, V]
+      #
+      # Initialize a new Dictionary.
+      #
+      # @param [Hash] hash A hash of items to add to the dictionary.
+      # @param [Integer] limit The maximum number of items in the dictionary.
+      # @param [false, Proc] sort Whether to sort the items in the dictionary.
+      def initialize: (?::Hash[untyped, untyped] hash, ?limit: Integer?, ?sort: (bool | Proc)) -> void
+
+      #
+      # Registers a new item in the dictionary.
+      #
+      # @param [#to_s] id The ID of the item.
+      # @param [Object] body The item to register.
+      #
+      # @return [self] The dictionary.
+      def register: (_ToS id, Object body) -> self
+
+      #
+      # Merges another dictionary into this one.
+      #
+      # @param [Discorb::Dictionary] other The dictionary to merge.
+      def merge: (Discorb::Dictionary other) -> untyped
+
+      #
+      # Removes an item from the dictionary.
+      #
+      # @param [#to_s] id The ID of the item to remove.
+      def remove: (_ToS id) -> untyped
+
+      #
+      # Get an item from the dictionary.
+      #
+      # @param [#to_s] id The ID of the item.
+      # @return [Object] The item.
+      # @return [nil] if the item was not found.
+      #
+      # @overload get(index)
+      #   @param [Integer] index The index of the item.
+      #
+      #   @return [Object] The item.
+      #   @return [nil] if the item is not found.
+      def get: (K id) -> V?
+
+      #
+      # Returns the values of the dictionary.
+      #
+      # @return [Array] The values of the dictionary.
+      def values: () -> ::Array[V]
+
+      #
+      # Checks if the dictionary has an ID.
+      #
+      # @param [#to_s] id The ID to check.
+      #
+      # @return [Boolean] `true` if the dictionary has the ID, `false` otherwise.
+      def has?: (_ToS id) -> bool
+
+      #
+      # Send a message to the array of values.
+      def method_missing: (untyped name) -> untyped
+
+      def respond_to_missing?: (untyped name, untyped args, untyped kwargs) -> bool
+
+      def inspect: () -> String
+
+      # @return [Integer] The maximum number of items in the dictionary.
+      attr_accessor limit: Integer
+    end
+    RBS
+    # #endregion
+    type_errors.each do |error, type|
+      base.gsub!(error, type)
+    end
+    base.gsub!("end\n\n\nend", "end\n")
+    base.gsub!(/ +$/m, "")
+    File.write("sig/discorb.rbs", base)
+  end
+
+  desc "Lint rbs with stree"
+  task :lint do
+    sh "stree check --plugins=rbs sig/**/*.rbs"
+  end
+
+  desc "Autofix rbs with stree"
+  task "lint:fix" do
+    sh "stree write --plugins=rbs sig/**/*.rbs"
   end
-  base.gsub!("end\n\n\nend", "end\n")
-  base.gsub!(/ +$/m, "")
-  File.write("sig/discorb.rbs", base)
 end
 
 task document: %i[document:yard document:replace]

data/Steepfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+
+  check "lib"
+
+  library "net-http", "timeout"
+
+  configure_code_diagnostics(D::Ruby.lenient)
+  configure_code_diagnostics do |config|
+    config[D::Ruby::UnsupportedSyntax] = nil
+    config[D::Ruby::UnexpectedSuper] = nil
+    config[D::Ruby::UnexpectedPositionalArgument] = nil
+    config[D::Ruby::InsufficientPositionalArguments] = nil
+    config[D::Ruby::UnknownInstanceVariable] = nil
+    config[D::Ruby::UnknownGlobalVariable] = nil
+  end
+end
+
+# target :test do
+#   signature "sig"
+#   signature "examples/sig"
+
+#   check "examples/**/*.rb"
+
+#   library "net-http", "timeout"
+# end

data/docs/application_command.md

@@ -82,6 +82,7 @@ In `options`, hash should be like this:
 | `:channel_types`         | `Array<Class<Discorb::Channel>>`         | Type of the channel option.                                                           |
 | `:autocomplete`          | `Proc`                                   | Autocomplete function.                                                                |
 | `:range`                 | `Range`                                  | Range of the option. Only valid for numeric options. (`:int`, `:float`)               |
+| `:length`                | `Range`                                  | Range of length of the option. Only valid for `:string`.                              |
 
 `choices` should be unspecified if you don't want to use it.
 `choices` example:

data/docs/events.md

@@ -69,10 +69,10 @@ end
 
 Fires when an event is received.
 
-| Parameter    | Type   | Description            |
-| ------------ | ------ | ---------------------- |
-| `event_name` | Symbol | The name of the event. |
-| `data`       | Hash   | The data of the event. |
+| Parameter    | Type     | Description            |
+| ------------ | -------- | ---------------------- |
+| `event_name` | `Symbol` | The name of the event. |
+| `data`       | `Hash`   | The data of the event. |
 
 #### `ready()`
 
@@ -91,6 +91,12 @@ Fires when the client is resumed connection.
 Fires when an error occurs during an event.
 Defaults to printing the error to stderr, override to handle it yourself.
 
+| Parameter    | Type            | Description                 |
+| ------------ | --------------- | --------------------------- |
+| `event_name` | `Symbol`        | The name of the event.      |
+| `args`       | `Array<Object>` | The arguments of the event. |
+| `error`      | `Exception`     | The error that occurred.    |
+
 #### `setup()`
 
 Fires when `discorb setup` is run.
@@ -557,16 +563,14 @@ Fires when a select menu is selected.
 | ------------- | -------------------------------------------------- | ----------------------- |
 | `interaction` | {Discorb::MessageComponentInteraction::SelectMenu} | The interaction object. |
 
-#### `form_submit(interaction)`
+#### `modal_submit(interaction)`
 
-Fires when a form is submitted.
+Fires when a modal is submitted.
 
 | Parameter     | Type                        | Description             |
 | ------------- | --------------------------- | ----------------------- |
 | `interaction` | {Discorb::ModalInteraction} | The interaction object. |
 
-#### `slash_command
-
 ### Voice events
 
 Because it's big, it's documented in {file:docs/voice_events.md}.
@@ -614,6 +618,38 @@ Fires when a scheduled event is ended.
 | --------- | ------------------------- | ------------------------------- |
 | `event`   | {Discorb::ScheduledEvent} | The scheduled event that ended. |
 
+### Automod events
+
+#### `auto_moderation_rule_create(rule)`
+
+Fires when an auto moderation rule is created.
+
+| Parameter | Type                   | Description                       |
+| --------- | ---------------------- | --------------------------------- |
+| `rule`    | {Discorb::AutoModRule} | The created auto moderation rule. |
+
+#### `auto_moderation_rule_update(rule)`
+
+Fires when an auto moderation rule is updated.
+
+| Parameter | Type                   | Description                       |
+| --------- | ---------------------- | --------------------------------- |
+| `rule`    | {Discorb::AutoModRule} | The updated auto moderation rule. |
+
+#### `auto_moderation_rule_delete(rule)`
+
+Fires when an auto moderation rule is deleted.
+
+| Parameter | Type                   | Description                       |
+| --------- | ---------------------- | --------------------------------- |
+| `rule`    | {Discorb::AutoModRule} | The deleted auto moderation rule. |
+
+#### `auto_moderation_action_execution(event)`
+
+| Parameter | Type                                                   | Description                |
+| --------- | ------------------------------------------------------ | -------------------------- |
+| `event`   | {Discorb::Gateway::AutoModerationActionExecutionEvent} | The auto moderation event. |
+
 ### Low-level events
 
 #### `guild_create(guild)`

data/docs/tutorial.md

@@ -21,7 +21,7 @@ Let's get started!
 - Good editor  
    They are recommended:
   - [VSCode](https://code.visualstudio.com/)
-  - [Atom](https://atom.io/)
+  - [RubyMine](https://www.jetbrains.com/ruby/)
   - [Sublime Text](https://www.sublimetext.com/)
   - [Brackets](https://brackets.io/)
   - [Notepad++](https://notepad-plus-plus.org/)
@@ -98,10 +98,10 @@ You will get other files if you specify `--git`.
 Open `main.rb`, you will see the following code:
 
 ```ruby
-require "discorb"
-require "dotenv"
+# frozen_string_literal: true
 
-Dotenv.load  # Loads .env file
+require "discorb"
+require "dotenv/load"  # Load environment variables from .env file.
 
 client = Discorb::Client.new  # Create client for connecting to Discord
 
@@ -115,10 +115,10 @@ client.run ENV["TOKEN"]  # Starts client
 Open `.env`, you will see:
 
 ```
-TOKEN=Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng
+TOKEN=
 ```
 
-Replace `Y0urB0tT0k3nHer3.Th1sT0ken.W0ntWorkB3c4useItH4sM34n1ng` with your bot token.
+Put your token after `TOKEN=`.
 Remember to keep this file secret!
 
 Open terminal and type:
@@ -194,4 +194,4 @@ You did it! Your bot won't respond to bot's messages anymore.
 This is the end of tutorial.
 
 To learn more, check out the [documentation](https://discorb-lib.github.io/).
-You can also check out [Examples](docs/examples).
+You can also check out [Examples](https://github.com/discorb-lib/discorb/tree/main/examples).

data/docs/voice_events.md

@@ -12,7 +12,7 @@ Fires when someone joins a voice channel.
 
 | Parameter | Type                  | Description                              |
 | --------- | --------------------- | ---------------------------------------- |
-| state     | {Discorb::VoiceState} | The voice state of the user that joined. |
+| `state`   | {Discorb::VoiceState} | The voice state of the user that joined. |
 
 #### `voice_channel_disconnect(state)`
 
@@ -20,7 +20,7 @@ Fires when someone leaves a voice channel.
 
 | Parameter | Type                  | Description                            |
 | --------- | --------------------- | -------------------------------------- |
-| state     | {Discorb::VoiceState} | The voice state of the user that left. |
+| `state`   | {Discorb::VoiceState} | The voice state of the user that left. |
 
 #### `voice_channel_move(before, after)`
 
@@ -28,8 +28,8 @@ Fires when someone moves to a different voice channel.
 
 | Parameter | Type                  | Description                                  |
 | --------- | --------------------- | -------------------------------------------- |
-| before    | {Discorb::VoiceState} | The voice state of the user before the move. |
-| after     | {Discorb::VoiceState} | The voice state of the user after the move.  |
+| `before`  | {Discorb::VoiceState} | The voice state of the user before the move. |
+| `after`   | {Discorb::VoiceState} | The voice state of the user after the move.  |
 
 #### `voice_channel_update(before, after)`
 
@@ -37,8 +37,8 @@ Fires when a voice channel is connected, disconnected, or updated.
 
 | Parameter | Type                  | Description                        |
 | --------- | --------------------- | ---------------------------------- |
-| before    | {Discorb::VoiceState} | The voice state before the update. |
-| after     | {Discorb::VoiceState} | The voice state after the update.  |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |
 
 ### Mute Events
 
@@ -281,5 +281,5 @@ Fired when a user changes voice state.
 
 | Parameter | Type                  | Description                        |
 | --------- | --------------------- | ---------------------------------- |
-| before    | {Discorb::VoiceState} | The voice state before the update. |
-| after     | {Discorb::VoiceState} | The voice state after the update.  |
+| `before`  | {Discorb::VoiceState} | The voice state before the update. |
+| `after`   | {Discorb::VoiceState} | The voice state after the update.  |