Skip to content

add en_SG documentation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 2, 2020
Merged

add en_SG documentation #19

merged 1 commit into from
Dec 2, 2020

Conversation

IonBazan
Copy link
Contributor

@IonBazan IonBazan commented Dec 2, 2020

This PR adds missing documentation for English (Singapore) - en_SG providers.

@pimjansen
Copy link
Contributor

pimjansen commented Dec 2, 2020

A lot of these things are already in core docs isnt it? Try only to document the locale specific

@IonBazan
Copy link
Contributor Author

IonBazan commented Dec 2, 2020

@pimjansen Not really:

  • floorNumber, apartmentNumber, streetNumber, blockNumber and streetPrefix are only available in this locale
  • nric, fin and singaporeId are Singapore-specific
  • internationalCodePrefix, voipNumber, premiumPhoneNumber are added by this locale
  • tollFreeInternationalNumber and tollFreeLineNumber are different from en_US's tollFreeNumber
  • mobileNumber and fixedLineNumber are different from en_US's phoneNumber which is choosing one of them in en_SG case.

Basically most of these methods are added because it is possible to distinguish between mobile and landline numbers in Singapore.

@pimjansen
Copy link
Contributor

EnUS is also not core, see the root providers

@IonBazan
Copy link
Contributor Author

IonBazan commented Dec 2, 2020

@pimjansen The documentation is always using en_US for these examples.
There is currently no documentation for root Address, PhoneNumber and Person providers in docs/formatters directory.

@krsriq
Copy link
Contributor

krsriq commented Dec 2, 2020

Couldn't find any providers that have public *Prefix (or *Suffix) methods that are documented (except for a couple in en_US and in ro_RO/Person), even though there are a lot that use prefixes/suffixes.

If we document streetPrefix here we should probably document all *Prefix/*Suffix methods (that are not in the root providers), which would make things a bit noisy.

@IonBazan
Copy link
Contributor Author

IonBazan commented Dec 2, 2020

@krsriq Thank you for your suggestion. I've removed non-important methods documentation and left only blockNumber for address.

Copy link
Member

@bram-pkg bram-pkg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@bram-pkg bram-pkg merged commit a6608ba into FakerPHP:main Dec 2, 2020
@IonBazan IonBazan deleted the en_SG branch December 2, 2020 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants