From 4497a32887a7852d667f03dfd817672bd18e1f75 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Mon, 4 Feb 2019 17:52:17 +0100 Subject: [PATCH] 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. --- docs/static/API.md | 2 +- docs/static/State.md | 2 +- mix.exs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/static/API.md b/docs/static/API.md index 56990091b..68cb0b2c9 100644 --- a/docs/static/API.md +++ b/docs/static/API.md @@ -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. diff --git a/docs/static/State.md b/docs/static/State.md index 409784a85..68d63927e 100644 --- a/docs/static/State.md +++ b/docs/static/State.md @@ -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 diff --git a/mix.exs b/mix.exs index c89c7e544..5ee0bf872 100644 --- a/mix.exs +++ b/mix.exs @@ -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(),