Skip to content

Conversation

@28Deepakpandey
Copy link
Contributor

@28Deepakpandey 28Deepakpandey commented Dec 18, 2025

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 .

Copy link
Member

@lonvia lonvia left a 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?

@28Deepakpandey
Copy link
Contributor Author

28Deepakpandey commented Dec 18, 2025

Hi @lonvia , I’ve corrected the remaining instances of Locale → Locales in the following files, as suggested:
docs/library/Getting-Started.md
docs/library/Result-Handling.md
docs/customize/Result-Formatting.md

Copy link
Member

@lonvia lonvia left a 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.

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
Copy link
Member

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.

| 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) |
Copy link
Member

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)
@lonvia
Copy link
Member

lonvia commented Dec 23, 2025

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.

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