cdgriffith / Box

Python dictionaries with advanced dot notation access
https://github.com/cdgriffith/Box/wiki
MIT License
2.64k stars 107 forks source link

Two small typos in Wiki / Types of Boxes #234

Closed schorfma closed 1 year ago

schorfma commented 1 year ago

Hello,


I noticed two small typos on the Wiki page Types of Boxes:

Types of Boxes / Box Dots

Support for traversing box lists as well!

my_box = Box({'data': [ {'rabbit': 'hole'} ] }, box_dots=True)
print(data.data[0].rabbit)
# hole

To change

my_box = Box({'data': [ {'rabbit': 'hole'} ] }, box_dots=True)
- print(data.data[0].rabbit)
+ print(my_box.data[0].rabbit)
# hole

Types of Boxes / Box Recast Values

If it cannot be converted, it will raise a BoxValueError (catachable with either BoxError or ValueError as well)

To change

- If it cannot be converted, it will raise a `BoxValueError` (catachable with either `BoxError` or `ValueError` as well)
+ If it cannot be converted, it will raise a `BoxValueError` (catchable with either `BoxError` or `ValueError` as well)

Thank you for your work on the Box library and kind regards Martin

cdgriffith commented 1 year ago

Updated, thank you for finding and reporting them!

cdgriffith commented 1 year ago

Actually going to keep this open just so when I do another release I remember to add you to contributors ;-)

cdgriffith commented 1 year ago

Added in 7.0.0