diff options
| author | Bobby <[email protected]> | 2022-09-10 20:15:43 -0400 |
|---|---|---|
| committer | Bobby <[email protected]> | 2022-09-10 20:15:43 -0400 |
| commit | c7ce552a0e161caa2ee6dda82a0b483ff38ffd13 (patch) | |
| tree | 485dba5d858397bdba7587c5bd6d6e9e616f4c18 /README.rst | |
| parent | 9205ead31f731ac8ce7234cadc3f1d67b813b351 (diff) | |
| download | edify-c7ce552a0e161caa2ee6dda82a0b483ff38ffd13.tar.xz edify-c7ce552a0e161caa2ee6dda82a0b483ff38ffd13.zip | |
Update docs - added more functions
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 7 |
1 files changed, 6 insertions, 1 deletions
@@ -67,7 +67,7 @@ Why Edify? Regex is a powerful tool, but its syntax is not very intuitive and can be difficult to build, understand, and use. It gets even more difficult when you have to deal with backtracking, look-ahead, and other features that make regex difficult. -That's where Edify becomes extremely useful. It allows you to create regular expressions in a programmatic way by invoking the ``RegexBuilder`` class, based on the SuperExpressive_ library. The API uses the `fluent builder pattern <https://en.wikipedia.org/wiki/Fluent_interface>`_, and is completely immutable. It is built to be discoverable and predictable. +That's where Edify becomes extremely useful. It allows you to create regular expressions in a programmatic way by invoking the ``RegexBuilder`` class [#f1]_. The API uses the `fluent builder pattern <https://en.wikipedia.org/wiki/Fluent_interface>`_, and is completely immutable. It is built to be discoverable and predictable. - Properties and methods describe what they do in plain English. - Order matters! Quantifiers are specified before the thing they change, just like in English (e.g. ``RegexBuilder().exactly(5).digit()``). @@ -140,3 +140,8 @@ Documentation Further API documentation is available on `edify.rftd.io <https://edify.readthedocs.io>`_. +.. rubric:: Footnotes + +.. [#f1] ``RegexBuilder`` class based on the `SuperExpressive`_ library. + +.. [1]: |