Skip to content

Commit 3123924

Browse files
author
Austin Bingham
committed
Updated README.
1 parent 602b1d8 commit 3123924

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ Find the range containg the key and value of a map entry:
1818

1919
```python
2020
source_map = YAMLWhere.from_string("a: 1\nb: 42")
21-
assert source_map.get_range("b") == Range(Position(1, 0), Position(1, 5))
21+
assert source_map.get_range(Item("b")) == Range(Position(1, 0), Position(1, 5))
2222
```
2323

2424
Or get the range of just the key:
2525
```python
2626
source_map = YAMLWhere.from_string("a: 1\nb: 42")
27-
assert source_map.get_key_range("a") == Range(Position(0, 0), Position(0, 1))
27+
assert source_map.get_range(Key("a")) == Range(Position(0, 0), Position(0, 1))
2828
```
2929

3030
Or just the value:
3131
```python
32-
source_map = YAMLWhere.from_string("a: 1\nbb: 42")
33-
assert source_map.get_value_range("bb") == Range(Position(1, 4), Position(1, 6))
32+
source_map = YAMLWhere.from_string("a: 1\nb: 42")
33+
assert source_map.get_range(Value("b")) == Range(Position(1, 3), Position(1, 5))
3434
```
3535

3636
You can also look up nested locations:
@@ -41,9 +41,9 @@ yaml = """a:
4141
doo: hola
4242
"""
4343
source_map = YAMLWhere.from_string(yaml)
44-
assert source_map.get_key_range("a", "b") == Range(Position(1, 4), Position(1, 5))
45-
assert source_map.get_key_range("a", "c") == Range(Position(2, 4), Position(2, 5))
46-
assert source_map.get_key_range("a", "c", "doo") == Range(Position(3, 8), Position(3, 11))
44+
assert source_map.get_range(Value("a"), Key("b")) == Range(Position(1, 4), Position(1, 5))
45+
assert source_map.get_range(Value("a"), Key("c")) == Range(Position(2, 4), Position(2, 5))
46+
assert source_map.get_range(Value("a"), Value("c"), Key("doo")) == Range(Position(3, 8), Position(3, 11))
4747
```
4848

4949
### Sequences
@@ -56,17 +56,14 @@ yaml = """[1,
5656
indented]
5757
"""
5858
source_map = YAMLWhere.from_string(yaml)
59-
assert source_map.get_range(0) == Range(Position(0, 1), Position(0, 2))
60-
assert source_map.get_range(1) == Range(Position(1, 1), Position(1, 2))
61-
assert source_map.get_range(2) == Range(Position(1, 4), Position(1, 7))
62-
assert source_map.get_range(3) == Range(Position(3, 5), Position(3, 13))
59+
assert source_map.get_range(Index(0)) == Range(Position(0, 1), Position(0, 2))
60+
assert source_map.get_range(Index(1)) == Range(Position(1, 1), Position(1, 2))
61+
assert source_map.get_range(Index(2)) == Range(Position(1, 4), Position(1, 7))
62+
assert source_map.get_range(Index(3)) == Range(Position(3, 5), Position(3, 13))
6363
```
6464

6565
## CI/CD
6666

67-
Bump the version like this:
67+
Tests will be run on every push to Github.
6868

69-
```
70-
$ bumpversion patch
71-
$ git push --follow-tags
72-
```
69+
Use the "bump-and-publish" job in Github Actions to make new releases.

0 commit comments

Comments
 (0)