Skip to content

Commit

Permalink
Misc doc changes (dashbitco#84)
Browse files Browse the repository at this point in the history
List of changes:
- Fix typos
- Use common source url
  • Loading branch information
kianmeng authored Jan 3, 2021
1 parent 458fcba commit 24d1598
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ NimbleParsec v0.6.0 requires Elixir v1.6+.

### Enhancements

* Optmize `repeat` with initial `lookahead`
* Optimize `repeat` with initial `lookahead`
* Add `@spec` to `parsec/2`

## v0.5.1 (2019-08-04)
Expand Down
12 changes: 6 additions & 6 deletions lib/nimble_parsec.ex
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ defmodule NimbleParsec do
import NimbleParsec
generate(choice([string("foo"), string("bar")]))
The command above will reteurn either "foo" or "bar". `generate/1`
The command above will return either "foo" or "bar". `generate/1`
is often used with pre-defined parsecs. In this case, the
`:export_metadata` flag must be set:
Expand All @@ -265,7 +265,7 @@ defmodule NimbleParsec do
## Notes
This feature is currenty experimental and may change in many ways.
This feature is currently experimental and may change in many ways.
Overall, there is no guarantee over the generated output, except
that it will generate a binary that is parseable by the parsec
itself, but even this guarantee may be broken by some validations.
Expand Down Expand Up @@ -1033,7 +1033,7 @@ defmodule NimbleParsec do
closest `choice/2`, `repeat/2`, etc. If there is no closest
operation to abort, then it errors.
Note a lookahead nevers changes the accumulated output nor the
Note a lookahead never changes the accumulated output nor the
context.
## Examples
Expand Down Expand Up @@ -1112,7 +1112,7 @@ defmodule NimbleParsec do
Otherwise it continues as usual. If there is no closest operation
to abort, then it errors.
Note a lookahead nevers changes the accumulated output nor the
Note a lookahead never changes the accumulated output nor the
context.
For an example, see `lookahead/2`.
Expand Down Expand Up @@ -1561,7 +1561,7 @@ defmodule NimbleParsec do

@doc """
Allow the combinator given on `to_repeat` to appear at least, at most
or exactly a given amout of times.
or exactly a given amount of times.
## Examples
Expand Down Expand Up @@ -1617,7 +1617,7 @@ defmodule NimbleParsec do
@doc """
Chooses one of the given combinators.
Expects at leasts two choices.
Expects at least two choices.
## Beware! Char combinators
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ defmodule NimbleParsec.MixProject do
%{
licenses: ["Apache 2"],
maintainers: ["José Valim"],
links: %{"GitHub" => "https://github.com/dashbitco/nimble_parsec"}
links: %{"GitHub" => @url}
}
end

Expand Down

0 comments on commit 24d1598

Please sign in to comment.