Skip to content

Commit a212661

Browse files
order: doc fix potentially misleading wording
1 parent 4b0abd1 commit a212661

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

src/order.cpp

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ compared by their positions in *alphabet*.
196196
:only-document-once:
197197
Compare two words using reversed lexicographic ordering.
198198
199-
The words are read from right to left before being compared.
199+
The words are read from right to left when being compared.
200200
201201
:param x: the first word.
202202
:type x: str | list[int]
@@ -226,7 +226,7 @@ The words are read from right to left before being compared.
226226
Compare two words using alphabet-aware reversed lexicographic ordering.
227227
228228
Letters are compared by their positions in *alphabet*, and the words are read
229-
from right to left before being compared.
229+
from right to left when being compared.
230230
231231
:param alphabet: the ordered alphabet containing the letters of both words.
232232
:type alphabet: Alphabet
@@ -257,7 +257,7 @@ from right to left before being compared.
257257
:only-document-once:
258258
Compare two words using reversed lenlex ordering.
259259
260-
Words are first ordered by length and then lexicographically after being read
260+
Words are first ordered by length and then lexicographically reading
261261
from right to left.
262262
263263
:param x: the first word.
@@ -287,7 +287,7 @@ from right to left.
287287
:only-document-once:
288288
Compare two words using alphabet-aware reversed lenlex ordering.
289289
290-
Words are first ordered by length and then lexicographically after being read
290+
Words are first ordered by length and then lexicographically reading
291291
from right to left. Letters are compared by their positions in *alphabet*.
292292
293293
:param alphabet: the ordered alphabet containing the letters of both words.
@@ -549,7 +549,7 @@ according to *alphabet*.
549549
:only-document-once:
550550
Compare two words using reversed wreath-product ordering.
551551
552-
The words are read from right to left before being compared. The *i*-th entry
552+
The words are read from right to left when being compared. The *i*-th entry
553553
of *levels* is the wreath-product level assigned to generator *i*.
554554
555555
:param levels: the level assigned to each generator.
@@ -587,7 +587,7 @@ Compare two words using alphabet-aware reversed wreath-product ordering.
587587
588588
Letters are mapped to their positions in *alphabet*, and the *i*-th entry of
589589
*levels* is the wreath-product level assigned to the *i*-th letter of
590-
*alphabet*. The words are read from right to left before being compared.
590+
*alphabet*. The words are read from right to left when being compared.
591591
592592
:param alphabet: the ordered alphabet containing the letters of both words.
593593
:type alphabet: Alphabet
@@ -624,7 +624,7 @@ Letters are mapped to their positions in *alphabet*, and the *i*-th entry of
624624
Compare two words using reversed weighted lenlex ordering.
625625
626626
Words are first ordered by total weight, then by length, and finally
627-
lexicographically after being read from right to left. The *i*-th entry of
627+
lexicographically read from right to left. The *i*-th entry of
628628
*weights* is the weight assigned to generator *i*.
629629
630630
:param weights: the weight assigned to each generator.
@@ -665,7 +665,7 @@ Compare two words using alphabet-aware reversed weighted lenlex ordering.
665665
Letters are mapped to their positions in *alphabet*, and the *i*-th entry of
666666
*weights* is the weight assigned to the *i*-th letter of *alphabet*. Words are
667667
first ordered by total weight, then by length, and finally lexicographically
668-
after being read from right to left.
668+
read from right to left.
669669
670670
:param alphabet: the ordered alphabet containing the letters of both words.
671671
:type alphabet: Alphabet
@@ -701,7 +701,7 @@ after being read from right to left.
701701
:only-document-once:
702702
Compare two words using reversed weighted lexicographic ordering.
703703
704-
Words are first ordered by total weight and then lexicographically after being
704+
Words are first ordered by total weight and then lexicographically
705705
read from right to left. The *i*-th entry of *weights* is the weight assigned
706706
to generator *i*.
707707
@@ -740,7 +740,7 @@ Compare two words using alphabet-aware reversed weighted lexicographic ordering.
740740
741741
Letters are mapped to their positions in *alphabet*, and the *i*-th entry of
742742
*weights* is the weight assigned to the *i*-th letter of *alphabet*. Words are
743-
first ordered by total weight and then lexicographically after being read from
743+
first ordered by total weight and then lexicographically read from
744744
right to left.
745745
746746
:param alphabet: the ordered alphabet containing the letters of both words.
@@ -778,7 +778,7 @@ right to left.
778778
Compare two words by length, weight, and reversed lexicographic order.
779779
780780
Words are first ordered by length, then by total weight, and finally
781-
lexicographically after being read from right to left. The *i*-th entry of
781+
lexicographically read from right to left. The *i*-th entry of
782782
*weights* is the weight assigned to generator *i*.
783783
784784
:param weights: the weight assigned to each generator.
@@ -819,7 +819,7 @@ Compare two words by length, weight, and alphabet-aware reversed lexicographic o
819819
Letters are mapped to their positions in *alphabet*, and the *i*-th entry of
820820
*weights* is the weight assigned to the *i*-th letter of *alphabet*. Words are
821821
first ordered by length, then by total weight, and finally lexicographically
822-
after being read from right to left.
822+
read from right to left.
823823
824824
:param alphabet: the ordered alphabet containing the letters of both words.
825825
:type alphabet: Alphabet

0 commit comments

Comments
 (0)