Skip to content

Commit

Permalink
Fixed documentation link
Browse files Browse the repository at this point in the history
  • Loading branch information
j-mie6 committed Jul 8, 2023
1 parent e11c3f7 commit eb5665a
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions parsley/shared/src/main/scala/parsley/errors/combinator.scala
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,9 @@ object combinator {
*/
def amend[A](p: Parsley[A]): Parsley[A] = new Parsley(new frontend.ErrorAmend(p.internal, partial = false))

// TODO: document
def partialAmend[A](p: Parsley[A]): Parsley[A] = new Parsley(new frontend.ErrorAmend(p.internal, partial = true))

/** This combinator prevents the action of any enclosing `amend` on the errors generated by the given
* parser.
*
Expand Down Expand Up @@ -170,19 +173,20 @@ object combinator {
* @param p a parser whose error messages should be amended unless its been entrenched.
* @return a parser that parses `p` but ensures any errors generated occur as if no input were consumed.
* @since 4.2.0
* @see [[amend `amend`]] and [[dislodge[A](by:Int)* `dislodge`]]
* @see [[amend `amend`]] and [[dislodge[A](p:parsley\.Parsley[A])* `dislodge`]]
* @group adj
*/
def amendThenDislodge[A](p: Parsley[A]): Parsley[A] = amendThenDislodge(Int.MaxValue)(p)
// TODO: document
def amendThenDislodge[A](by: Int)(p: Parsley[A]): Parsley[A] = dislodge(by)(amend(p))

// TODO: document
def partialAmend[A](p: Parsley[A]): Parsley[A] = new Parsley(new frontend.ErrorAmend(p.internal, partial = true))
// These don't need coverage really, they are basically the same as the ones above
// $COVERAGE-OFF$
// TODO: document
def partialAmendThenDislodge[A](p: Parsley[A]): Parsley[A] = partialAmendThenDislodge(Int.MaxValue)(p)
// TODO: document
def partialAmendThenDislodge[A](by: Int)(p: Parsley[A]): Parsley[A] = dislodge(by)(partialAmend(p))
// $COVERAGE-ON$

/** This combinator marks any errors within the given parser as being ''lexical errors''.
*
Expand Down

0 comments on commit eb5665a

Please sign in to comment.