Skip to content

Commit 4497a32

Browse files
jchristgitKraigie
authored andcommitted
Documentation: Display "Nostrum" as package name in sidebar, reference proper Ratelimiter callback (#123)
* Display `Nostrum` as package name in sidebar. * Reference proper `Ratelimiter` callback. * Reference `image_url/1` instead.
1 parent eae02ce commit 4497a32

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/static/API.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ The ratelimiter at a high level works something like this:
5959
## Rest Only
6060
If you only want to use the REST portion of the provided API, the only process
6161
needed is the ratelimiter. This can be manually started by calling
62-
`Nostrum.Api.Ratelimiter.start_link/0`. If you don't want to start Nostrum you
62+
`Nostrum.Api.Ratelimiter.start_link/1`. If you don't want to start Nostrum you
6363
can add `runtime: false` to the dependency options.

docs/static/State.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ simple interactions with the cache. Feel free to suggest additional functionalit
77
Nostrum uses structs when appropriate to pass around objects from Discord.
88

99
In some cases, the struct modules will include helper functions for interacting
10-
with the struct. See `Nostrum.Struct.Emoji.format_custom_emoji/2` for an example.
10+
with the struct. See `Nostrum.Struct.Emoji.image_url/1` for an example.
1111

1212
## Guilds
1313
Each guild is ran in its own `GenServer` process, all of which are ran under a

mix.exs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ defmodule Nostrum.Mixfile do
1010
start_permanent: Mix.env() == :prod,
1111
description: "An elixir Discord library",
1212
package: package(),
13-
name: "Elixir",
13+
name: "Nostrum",
1414
source_url: "https://github.com/kraigie/nostrum",
1515
homepage_url: "https://github.com/kraigie/nostrum",
1616
deps: deps(),

0 commit comments

Comments
 (0)