Skip to content

docs: fix typos in example code comments - #181

Open
Avicennasis wants to merge 1 commit into
heremaps:masterfrom
Avicennasis:docs/fix-typos
Open

docs: fix typos in example code comments#181
Avicennasis wants to merge 1 commit into
heremaps:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fixes 13 typos in JSDoc/block comments across 6 example folders. Comments only - no executable code is touched and no identifiers are renamed.

  • map-with-pedestrian-route-from-a-to-b/demo.js: Opens/Closes a infobubble -> an infobubble; can be found the full JS + HTML code -> can be found in the full JS + HTML code
  • map-with-route-from-a-to-b-using-public-transport/demo.js: same two fixes
  • reverse-geocode-an-address-from-location/demo.js: same two fixes
  • search-for-landmark/demo.js: same two fixes
  • geocode-a-location-from-address/demo.js: same two fixes
  • geocode-a-location-from-structured-address/demo.js: same two fixes, plus address details of 425 Randolph St -> details of 425 Randolph St (stray double space)

On an infobubble: open-infobubble/demo.js already uses the correct article, so this just brings the other examples in line.

Deliberately left alone

The misspelled function names addManueversToMap / addManueversToPanel ("Manuevers" -> "Maneuvers") appear in map-with-pedestrian-route-from-a-to-b, map-with-route-from-a-to-b-using-public-transport and map-with-route-from-a-to-b. They are real identifiers with declarations and call sites, and these files are copy-paste starting points for developers, so I did not rename them - that is a maintainer call, not a typo fix.

The same two comment typos also appear in map-with-route-from-a-to-b/demo.js (both) and map-with-isoline-route/demo.js (can be found the full). I kept this PR to the files I had verified, but I'm happy to extend it to those two if you'd prefer the whole repo consistent in one go.

No functional changes.

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.

1 participant