search

janet-lang / spork

Various Janet utility modules - the official "Contrib" library.
MIT License
125 stars 36 forks source link

Typos in code & doc for word `probability` #105

Closed masoodrb closed 1 year ago

masoodrb commented 1 year ago

There seem to be a typo in the function math/check-propability which should be math/check-probability and the documentation of the function math/binominal-distribution which should also be probability instead of propability.

sogaiu commented 1 year ago

I think you're prop^Hbably right about those things: https://github.com/janet-lang/spork/blob/465d489389cb093cc474379772fa52691819c6c2/spork/math.janet#L363-L369

pepe commented 1 year ago

Oh. That would be me :-)

sogaiu commented 1 year ago

Does a PR seem welcome for this?

Change of name in a function does present an issue of compatibility but may be it hasn't been too long since this got added?

The simple thing would be to just fix the function name and docs.

pepe commented 1 year ago

If you have spare moments, please do. No one except me used it :-D, so the change would not be such an issue.

masoodrb commented 1 year ago

I suppose there is a high chance that if there was a user of this function they would have noticed the typo. I was just going through the docs because I was bored.

sogaiu commented 1 year ago

@masoodrb I hope the reading was entertaining :)

Would you like to do a PR?

If not, I can work on one.

masoodrb commented 1 year ago

Created PR here PR #106