Skip to content

Commit

Permalink
docs: fix spellings (#2)
Browse files Browse the repository at this point in the history
* docs: add module docs for color and flavor

* readme: fix misspelling of Catppuccin

* readme: fix general misspellings

* doc: fix misspellings

* version: bump patch
  • Loading branch information
MikaelFangel authored Jun 3, 2024
1 parent 7f8a74c commit 142fcd4
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -795,15 +795,15 @@

## Usage

1. Inlcude the depencency in your mix project.
1. Include the dependency in your mix project.
```elixir
def deps do
[
{:catppuccin, github: "MikaelFangel/elixir", tag: "v0.1.0"}
{:catppuccin, github: "MikaelFangel/elixir", tag: "v0.1.1"}
]
end
```
2. Enjoy the access to the beautifull catppuccin palette.
2. Enjoy the beautiful Catppuccin palette.

## Examples

Expand All @@ -824,7 +824,7 @@ Catppuccin.latte
### Get flavor emoji
```elixir
Catppuccin.latte
|> Catpuccin.Flavor.emoji
|> Catppuccin.Flavor.emoji
```

<!-- this section is optional -->
Expand Down
2 changes: 1 addition & 1 deletion lib/catppuccin/catppucin.ex
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ defmodule Catppuccin do
alias Catppuccin.FlavorETS

@doc """
Retuns the flavor data for the latte flavor.
Returns the flavor data for the latte flavor.
"""
@spec latte() :: Flavor.t()
def latte do
Expand Down
8 changes: 6 additions & 2 deletions lib/catppuccin/color.ex
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
defmodule Catppuccin.Color do
@moduledoc """
Module for handling color data.
"""

alias Catppuccin.Flavor

@typedoc """
Datastructure representing a color i hex, rgb, and hsl.
Data structure representing a color i hex, rgb, and hsl.
"""
@type t :: %__MODULE__{
name: String.t(),
Expand Down Expand Up @@ -94,7 +98,7 @@ defmodule Catppuccin.Color do
end

@doc """
Retuns the color data for the rosewater color for a given flavor.
Returns the color data for the rosewater color for a given flavor.
## Examples
Expand Down
6 changes: 5 additions & 1 deletion lib/catppuccin/flavor.ex
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
defmodule Catppuccin.Flavor do
@moduledoc """
Module to retrieve information about flavors.
"""

@typedoc """
Datastructure representing a flavor.
Data structure representing a flavor.
"""
@type t :: %__MODULE__{
name: String.t(),
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule Catppuccin.MixProject do
def project do
[
app: :catppuccin,
version: "0.1.0",
version: "0.1.1",
elixir: "~> 1.15",
start_permanent: Mix.env() == :prod,
deps: deps(),
Expand Down

0 comments on commit 142fcd4

Please sign in to comment.