-
-
Notifications
You must be signed in to change notification settings - Fork 795
Fix typo: Locale → Locales in Getting Started docs #3917
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
Conversation
lonvia
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are at least two more places with the wrong name in this file and one more in docs/customize/Result-Formatting.md. Can you please make sure you get them all?
|
Hi @lonvia , I’ve corrected the remaining instances of Locale → Locales in the following files, as suggested: |
lonvia
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please squash your commits into a single one once you have addressed the comments and force-push the result? Then it would be ready to merge.
docs/library/Getting-Started.md
Outdated
| or `ref`. | ||
|
|
||
| The `Locale` object can be applied to a name dictionary to return the best-matching | ||
| The `locale` object can be applied to a name dictionary to return the best-matching |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should start with an upper case letter.
docs/customize/Result-Formatting.md
Outdated
| | Option | Description | | ||
| |-----------------|-------------| | ||
| | locales | [Locale](../library/Result-Handling.md#locale) object for the requested language(s) | | ||
| | Locales | [Locales](../library/Result-Handling.md#Locales) object for the requested language(s) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lower-case was correct for the option name, see here. Same for URL, the fragments are lower-cased.
…lt-Handling, and Result-Formatting docs for consistency (resolves osm-search#3912)
400af8d to
787d0de
Compare
|
Something went wrong with this rebase. It now contains a mix of my and your changes. I'm not quite sure how this happened. It might be easier at this point to close this PR and start afresh. Sorry for the inconvenience. git can be difficult to get a handle on at the beginning. |
I corrected a documentation error in the Getting Started guide. The helper class name was mistakenly written as Locale instead of Locales in 3–4 places. This update ensures consistency with the actual class name and avoids confusion for new users following the docs.
These updates address the issue mentioned in #3912 .