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

Javadoc: Update links and fix typos #314

Merged
merged 1 commit into from
Aug 9, 2017
Merged

Javadoc: Update links and fix typos #314

merged 1 commit into from
Aug 9, 2017

Conversation

apjanke
Copy link
Contributor

@apjanke apjanke commented Aug 9, 2017

Updates various outdated/broken links, and fixes some typos and grammatical errors.

Changes are restricted to the Javadocs.

Updates outdated/broken links, fixes typos, and corrects a few grammatical errors.
@@ -83,7 +83,7 @@ public DirectionsApiRequest destination(String destination) {
}

/**
* The origin, as a latitude,longitude location.
* The origin, as a latitude/longitude location.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/cc @sarahmaddox I'm unsure about this change, thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I browsed through the whole source tree, and "latitude/longitude" seems to be a lot more common that "latitude,longitude". Seems like it should have parens and a space if it's going to be "(latitude, longitude)".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sgtm

Copy link
Contributor

@domesticmouse domesticmouse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. @sarahmaddox it's all yours now =)

Copy link
Contributor

@sarahmaddox sarahmaddox left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

*
* <p>For more information see <a
* href="https://developers.google.com/maps/documentation/geocoding/?hl=pl#Viewports">Viewports
* documentation</a>.
* href="https://developers.google.com/maps/documentation/geocoding/intro?hl=pl#Viewports">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While you're here, please would you fix this URL? It should be:
https://developers.google.com/maps/documentation/geocoding/start#Viewports

FYI, the URL parameter "hl=pl" shouldn't be there. It's requesting a version of the page in Polish (which we don't actually have) and is probably the result of someone from Poland making this change while viewing the docs.

To see the language specification in action, try this URL which requests the page in German:
https://developers.google.com/maps/documentation/geocoding/start?hl=de

If you leave the parameter off the URL, the developer docs site will look for language info in the user's browser or as specified in the language option at the bottom of the page.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@@ -105,8 +105,8 @@ public GeocodingApiRequest bounds(LatLng southWestBound, LatLng northEastBound)
* parameter will only influence, not fully restrict, results from the geocoder.
*
* <p>For more information see <a
* href="https://developers.google.com/maps/documentation/geocoding/?hl=pl#RegionCodes">Region
* Codes</a>.
* href="https://developers.google.com/maps/documentation/geocoding/intro?hl=pl#RegionCodes">Region
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to my previous comment, the URL should be:
https://developers.google.com/maps/documentation/geocoding/intro#RegionCodes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@@ -120,7 +120,7 @@ public GeocodingApiRequest region(String region) {
* fully restrict the results from the geocoder.
*
* <p>For more information see <a
* href="https://developers.google.com/maps/documentation/geocoding/?hl=pl#ComponentFiltering">
* href="https://developers.google.com/maps/documentation/geocoding/intro?hl=pl#ComponentFiltering">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@apjanke
Copy link
Contributor Author

apjanke commented Aug 9, 2017

Fixed the hl=pl things. Sorry for not noticing that earlier.

@domesticmouse domesticmouse merged commit 075c01e into googlemaps:master Aug 9, 2017
@apjanke apjanke deleted the fix-urls-and-typos-in-javadoc branch August 9, 2017 11: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.

3 participants