8000 Minor update to HowToUsePyparsing.rst · pyparsing/pyparsing@c09eb6e · GitHub
[go: up one dir, main page]

Skip to content

Commit c09eb6e

Browse files
committed
Minor update to HowToUsePyparsing.rst
1 parent 395431a commit c09eb6e

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/HowToUsePyparsing.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Using the pyparsing module
55
:author: Paul McGuire
66
:address: ptmcg.pm+pyparsing@gmail.com
77

8-
:revision: 3.1.0
9-
:date: April, 2023
8+
:revision: 3.1.1
9+
:date: July, 2023
1010

1111
:copyright: Copyright |copy| 2003-2023 Paul McGuire.
1212

@@ -42,7 +42,7 @@ synonyms, but the synonyms will be removed in a future release.*
4242

4343
*If you are using this documentation, but working with a 2.4.x version of pyparsing,
4444
you'll need to convert methods and arguments from the documented snake_case
45-
names to the legacy camelCase names. In pyparsing 3.0.x, both forms are
45+
names to the legacy camelCase names. In pyparsing 3.0.x and 3.1.x, both forms are
4646
supported, but the legacy forms are deprecated; they will be dropped in a
4747
future release.*
4848

@@ -58,8 +58,8 @@ To parse an incoming data string, the client code must follow these steps:
5858
this to a program variable. Optional results names or parse
5959
actions can also be defined at this time.
6060

61-
2. Call ``parse_string()`` or ``scan_string()`` on this variable, passing in
62-
the string to
61+
2. Call ``parse_string()``, ``scan_string()``, or ``search_string()``
62+
on this variable, passing in the string to
6363
be parsed. During the matching process, whitespace between
6464
tokens is skipped by default (although this can be changed).
6565
When token matches occur, any defined parse action methods are
@@ -692,6 +692,8 @@ Expression subclasses
692692
parse element is not found in the input string; parse action will only
693693
be called if a match is found, or if a default is specified.
694694

695+
An optional element ``expr`` can also be expressed using ``expr | ""``.
696+
695697
(``Opt`` was formerly named ``Optional``, but since the standard Python
696698
library module ``typing`` now defines ``Optional``, the pyparsing class has
697699
been renamed to ``Opt``. A compatibility synonym ``Optional`` is defined,

0 commit comments

Comments
 (0)
0