isValid is exported as validate

Question

isValid is exported as validate

WaldoJeffers opened this issue 6 years ago · comments

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 ^^

aymeric bouzy · Answer 1 · Thu Aug 30 2018 23:45:42 GMT+0800 (China Standard Time)

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 · Answer 2 · Fri Aug 31 2018 00:00:10 GMT+0800 (China Standard Time)

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

aymeric bouzy · Answer 3 · Fri Aug 31 2018 00:04:20 GMT+0800 (China Standard Time)

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

WaldoJeffers · Answer 4 · Fri Aug 31 2018 00:07:08 GMT+0800 (China Standard Time)

Sure, fix is in #2