Skip to content

Commit 6add25f

Browse files
Improved docs
1 parent 0a3e9d7 commit 6add25f

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

src/fa-types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ export interface FAIterator<S, O = Iterable<S>> {
121121
* The constructed FA is always owned by the builder.
122122
*
123123
* @template S The type of a state.
124-
* @template O The type of the value each state maps to.
124+
* @template T The transition type of the values linking states.
125125
*/
126126
export interface FABuilder<S, T> {
127127
/**
@@ -140,7 +140,7 @@ export interface FABuilder<S, T> {
140140
/**
141141
* Returns whether the given state is a final state.
142142
*
143-
* This operation is assumed to be semantically equivalent to {@link FAIterator#isFinal}.
143+
* This operation is assumed to be semantically equivalent to {@link FAIterator.isFinal}.
144144
*/
145145
readonly isFinal: (state: S) => boolean;
146146
/**

src/js/parser.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ export interface ParseOptions {
117117
* - Removing constant 0 and constant 1 quantifiers.
118118
* - Inlining single-alternative groups.
119119
*
120-
* These simplifications might prevent that certain backreferences or assertions from throwing an error. It's
121-
* usually good to have them enabled since parsing is usually faster and the produced RE AST is smaller.
120+
* These simplifications might prevent certain backreferences or assertions from throwing an error. It's usually
121+
* good to have them enabled since parsing is usually faster and the produced RE AST is smaller.
122122
*
123123
* If the produced RE AST is supposed to be a literal translation, then simplifications have to be disabled.
124124
*

src/nfa.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ export interface ReadonlyNFA extends FiniteAutomaton, TransitionIterable<NFA.Rea
9494
* - Between any two states, there can at most be one transition.
9595
*
9696
* This means that all transitions between two nodes will be merged into one. This is implemented as a simple
97-
* `CharSet#union`. As a consequence, `/a|a/` and `/a/` have the same state machine in this NFA implementation.
97+
* {@link CharSet.union}. As a consequence, `/a|a/` and `/a/` have the same state machine in this NFA implementation.
9898
*/
9999
export class NFA implements ReadonlyNFA {
100100
readonly nodes: NFA.NodeList;

0 commit comments

Comments
 (0)