From 488444ccbf37ca02e9016c40f7c18541bd86cd0a Mon Sep 17 00:00:00 2001 From: Real-Septicake Date: Tue, 9 Apr 2024 13:33:01 -0400 Subject: [PATCH] Applied suggestions to other files' documentation --- src/internal/index.ts | 4 ++-- src/internal/parser.ts | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/internal/index.ts b/src/internal/index.ts index 8ccd5b6..b9406e1 100644 --- a/src/internal/index.ts +++ b/src/internal/index.ts @@ -11,7 +11,7 @@ export type FullParserOpts = { }; /** - * A function that parses through the input plaintext with the full parser and returns the AST representing the + * A function that parses through the input text with the full parser and returns the AST representing the * result. * * @param input The input string to parse. @@ -29,7 +29,7 @@ export function fullParser(input: string, opts: FullParserOpts): M.MfmNode[] { } /** - * A function that parses through the input plaintext with the simple parser and returns the AST representing the + * A function that parses through the input text with the simple parser and returns the AST representing the * result. * * @param input The input string to parse. diff --git a/src/internal/parser.ts b/src/internal/parser.ts index 7ffffae..ac64553 100644 --- a/src/internal/parser.ts +++ b/src/internal/parser.ts @@ -21,15 +21,15 @@ const newLine = P.alt([P.crlf, P.cr, P.lf]); /** * A function that returns a {@link P.Parser Parser} which goes through the supplied parsers sequentially. - * If the first provided parser fails, a {@link P.Failure Failure} object is returned, the plaintext of the - * successfully parsed portion of the input if any other parsers fail, and an array of the values of the - * parsers' {@link P.Success Successes}. + * If the first provided parser fails, a {@link P.Failure Failure} object is returned, the matched portion of the + * input text is returned if any other parsers fail, and an array of the values of the parsers' + * {@link P.Success Successes}. * * @param parsers The list of {@link P.Parser Parsers} to use. * @returns A {@link P.Parser Parser} that goes through the supplied parsers sequentially and makes sure that each * succeeds. If the first parser fails, a {@link P.Failure Failure} object is returned. If any other parser - * fails, the plaintext of the successfully parsed portion of the input text is returned. If all succeed, - * the array of each {@link P.Success Success'} value is returned. + * fails, the matched portion of the input text is returned. If all succeed, the array of each + * {@link P.Success Success'} value is returned. */ function seqOrText(parsers: P.Parser[]): P.Parser { return new P.Parser((input, index, state) => {