Skip to content

Commit

Permalink
Documentation: Display "Nostrum" as package name in sidebar, referenc…
Browse files Browse the repository at this point in the history
…e proper `Ratelimiter` callback (#123)

* Display `Nostrum` as package name in sidebar.

* Reference proper `Ratelimiter` callback.

* Reference `image_url/1` instead.
  • Loading branch information
jchristgit authored and Kraigie committed Feb 4, 2019
1 parent eae02ce commit 4497a32
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/static/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ The ratelimiter at a high level works something like this:
## Rest Only
If you only want to use the REST portion of the provided API, the only process
needed is the ratelimiter. This can be manually started by calling
`Nostrum.Api.Ratelimiter.start_link/0`. If you don't want to start Nostrum you
`Nostrum.Api.Ratelimiter.start_link/1`. If you don't want to start Nostrum you
can add `runtime: false` to the dependency options.
2 changes: 1 addition & 1 deletion docs/static/State.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ simple interactions with the cache. Feel free to suggest additional functionalit
Nostrum uses structs when appropriate to pass around objects from Discord.

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

## Guilds
Each guild is ran in its own `GenServer` process, all of which are ran under a
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ defmodule Nostrum.Mixfile do
start_permanent: Mix.env() == :prod,
description: "An elixir Discord library",
package: package(),
name: "Elixir",
name: "Nostrum",
source_url: "https://github.com/kraigie/nostrum",
homepage_url: "https://github.com/kraigie/nostrum",
deps: deps(),
Expand Down

0 comments on commit 4497a32

Please # to comment.