Skip to content

Commit aef2b81

Browse files
Merge pull request #6 from fleetingbytes/beta
docs: bettes placement of links
2 parents 4eec549 + 9af1bbc commit aef2b81

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Regular expressions for humans.
44

5-
Human-regex provides the classes `StringRegex` and `BytesRegex` which are subclasses of `str` or `bytes`, respectively. They contain methods and properties which can produce your regular expressions with *readable code*.
5+
The [human-regex](https://github.com/fleetingbytes/human-regex) package provides the classes `StringRegex` and `BytesRegex` which are subclasses of `str` or `bytes`, respectively. They contain methods and properties which can produce your regular expressions with *readable code*.
66

77
```py
88
from human_regex import StringRegex as Sre
@@ -36,6 +36,9 @@ word_startswith_a = word.prepend("a").named("starts_with_a").prepend(r"\b").appe
3636
assert word_startswith_a == r"\b(?P<starts_with_a>a\w*)\b"
3737
```
3838

39+
- [Full Documentation](https://fleetingbytes.github.io/human-regex/human_regex.html)
40+
41+
3942
## Subclasses of `str`, `bytes`
4043

4144
`StringRegex` and `BytesRegex` are subclasses of `str` or `bytes`, respectively. They interoperate with these objects seamlessly. Here are some alternative ways how to construct the pattern from the previous example in the Overview section. Here we mix `StringRegex` and `str` instances:
@@ -143,9 +146,3 @@ b = Bre.concatenate(map(lambda i: str.encode(chr(i)), some_integers))
143146
## Inherited Methods and Properties
144147

145148
`StringRegex` and `BytesRegex` differ slightly in their private class variables, but their public methods and properties have all been inherited from the `human_regex.bases.general_regex.GeneralRegexBase` class. Thus, the documentation of the `StringRegex` or `BytesRegex`'s inherited public methods and properties is to be looked up there. For methods proxied from the built-in [re](https://docs.python.org/library/re.html) module or inherited from `str`, or `bytes`, look in the Python's standard library documentation.
146-
147-
## Links
148-
149-
- [Repository](https://github.com/fleetingbytes/human-regex)
150-
- [Documentation](https://fleetingbytes.github.io/human-regex/human_regex.html)
151-

0 commit comments

Comments
 (0)