Skip to content
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

Standardize ISO method name in README and docs #173

Conversation

froschdesign
Copy link

Updated the method name from createIteratorFromIso3166 to createIteratorFromISO3166 in README.md and docs/index.md. This standardizes the capitalization in the method name, ensuring consistency throughout the documentation.

/**
* Create a HolidayIterator from an ISO 3166-code.
*
* @param string $isoCode
*
* @return HolidayIterator
*/
public function createIteratorFromISO3166(string $isoCode): HolidayIterator

Updated the method name from 'createIteratorFromIso3166' to 'createIteratorFromISO3166' in README.md and docs/index.md. This standardizes the capitalization in the method name, ensuring consistency throughout the documentation.

Signed-off-by: Frank Brückner <[email protected]>
@heiglandreas
Copy link
Owner

Thank you for taking the time to create this PR!

But to be honest: In in the light of the recently accepted RFC on Casing of acronyms in class and method names that states that "Abbreviations, acronyms, and initialisms should be treated like regular words, thus they should be written with an uppercase first character, followed by lowercase characters" I'd rather say that the casing of the function name was wrong in the first place 🙈

That should have been createIteratorFromIso3166 all along!

THanks for making me aware of that. If you want to change that PR I'd be more than happy, otherwise I'd do that change later.

@froschdesign froschdesign deleted the hotfix/docs/wrong-method-name branch May 29, 2024 10:09
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.

2 participants