avi-perl / Hebrew

A python package with methods to handle the complexities of Hebrew text, calculate Gematria, and more.
https://hebrew.aviperl.me/
MIT License
37 stars 7 forks source link

Documentation is not properly documenting from_hebrew geresh settings. #20

Closed SZRabinowitz closed 3 months ago

SZRabinowitz commented 7 months ago

in there documentation it doesn't properly show how to remove geresh punctuation.

I quote:

# Do not add punctuation
hs2 = Hebrew.from_number(2, geresh=False)
print(hs2)  # ב

It should say:

# Do not add punctuation
hs2 = Hebrew.from_number(2, geresh=False, punctuate=False)
print(hs2)  # ב

Thanks!