Skip to content

docs: fix typos and copy-paste errors in example comments - #5

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

docs: fix typos and copy-paste errors in example comments#5
Avicennasis wants to merge 1 commit into
heremaps:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fix 17 typos and copy-pasted comments across 5 examples. Comments only - no code,
no identifiers and no user-visible strings were changed.

All four routing examples (map-with-pedestrian-route-from-a-to-b,
map-with-route-from-a-to-b, map-with-route-from-a-to-b-using-public-transport,
map-with-truck-route-from-a-to-b), in demo.js:

  • A representitive styling can be found the full JS + HTML code -> A representative styling can be found in the full JS + HTML code (typo plus the missing in)
  • Opens/Closes a infobubble -> Opens/Closes an infobubble

map-with-route-from-a-to-b-using-public-transport/demo.js

  • Calculates and displays a public trasnsport route -> ... a public transport route

Copy-pasted JSDoc summaries. addWaypointsToPanel and addSummaryToPanel both
carry the summary line belonging to addManueversToMap
(Creates a series of H.map.Marker points from the route and adds them to the map.),
which describes neither function:

  • addWaypointsToPanel (pedestrian, route, public-transport) -> Creates a list of the route waypoints and adds it to the route panel.
  • addSummaryToPanel (all four) -> Creates the route summary and adds it to the route panel.

custom-cluster-theme/demo.js

  • Get a reference to data object our noise points -> Get a reference to data object of our noise point (the callback receives a single noisePoint)

Note: addManueversToMap / addManueversToPanel are also misspelled
(Manuevers should be Maneuvers), but those are function names, so they were
deliberately left alone here to keep this PR comment-only. Happy to send that as a
separate rename if you would like it.

Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
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