aymericbouzy / french-ssn

🇫🇷 A parser / validator for French Social Security Number
8 stars 5 forks source link

isValid is exported as validate #1

Closed WaldoJeffers closed 6 years ago

WaldoJeffers commented 6 years ago

Hello,

This seems to be a very nice library. I was about to create one with the same purpose before stumbling upon french-ssn. The README documents a isValid function, but the library exports a validate function. This will be easy to fix but it can confuse newcomers ^^

aymericbouzy commented 6 years ago

Sorry for not answering earlier, I was on holiday. This is a very good point, want to make a PR? Also, don't hesitate creating issues for things that might be missing in this package, i'll be glad to have a look into it.

WaldoJeffers commented 6 years ago

@aymericbouzy Sure! Which name do you want to keep? isValid or validate?

aymericbouzy commented 6 years ago

I think it's better not to break anything : only editing the documentation seems a better choice. Therefore I would keep validate.

WaldoJeffers commented 6 years ago

Sure, fix is in https://github.com/aymericbouzy/french-ssn/pull/2