Geocoding guide overview#124
Merged
Merged
Conversation
rohitgeo
reviewed
Jul 26, 2017
rohitgeo
left a comment
rohitgeo
left a comment
Contributor
There was a problem hiding this comment.
@jyaistMap thanks for your pull request. I've requested a couple of changes. Please update your pull request with those and move the apidoc changes to the geosaurus repo where the source code is maintained.
| <dt id="arcgis.geocoding.geocode"> | ||
| <code class="descclassname">geocoding.</code><code class="descname">geocode</code><span class="sig-paren">(</span><em>address</em>, <em>search_extent=None</em>, <em>location=None</em>, <em>distance=None</em>, <em>out_sr=None</em>, <em>category=None</em>, <em>out_fields=’*’</em>, <em>max_locations=20</em>, <em>magic_key=None</em>, <em>for_storage=False</em>, <em>geocoder=None</em><span class="sig-paren">)</span><a class="headerlink" href="#arcgis.geocoding.geocode" title="Permalink to this definition">¶</a></dt> | ||
| <dd><p>The geocode function geocodes one location per request.</p> | ||
| <dd><p>The geocode function geocodes one location per request. This function corresponds to the findAddressCandidates operation at |
Contributor
There was a problem hiding this comment.
@jyaistMap Updates to the API doc needs to be made in the source code repo. The apidoc is generated by running sphinx on the source code and any changes made here will be overwritten. Can you remove the changes from here and send a pull request for these changes in the source code repo for geosaurus?
| "anaconda-cloud": {}, | ||
| "kernelspec": { | ||
| "display_name": "Python [Root]", | ||
| "display_name": "Python [conda env:arcgis-pyapi]", |
Contributor
There was a problem hiding this comment.
There are no real changes to this notebook, so it should be excluded from the pull request. Also, we shouldn't change the kernelspec to include custom kernels as those opening notebooks with non-standard/default kernels are prompted with an error saying that the kernel cannot be found and if another kernel should be used.
| "\n", | ||
| "#### Geocoding Module Types and Functions\n", | ||
| "\n", | ||
| "The geocoding module provides a `Geocoder` class to construct `geocoder` objects from portal geocoding service items or from the url to a [geocoding service]((https://server.arcgis.com/en/server/latest/publish-services/linux/geocode-services.htm). In addition, the `get_geocoders` function returns a list of `geocoders` accessible in a portal. \n", |
Contributor
There was a problem hiding this comment.
I would prefer using the generic term 'GIS' instead of portal. Portal is only available with ArcGIS Enterprise and not with ArcGIS Online.
Collaborator
Author
There was a problem hiding this comment.
I incorporated your feedback.
jyaistMap
force-pushed
the
geocoding_guide_overview
branch
from
6f225b6 to
412a0b3
Compare
Contributor
|
Looks good, thanks @jyaistMap |
rohitgeo
pushed a commit
that referenced
this pull request
Aug 15, 2017
* added geocoding module introduction. (#124) * Auth page updates (#126) * Use ReadTheDocs theme * api doc updates * gis doc update * clean up doc * bug fixes in clone portal sample * V101 updates (#75) * v101 added a topic on masking passwords to the 'working with auth schemes' page * guide v101 added section showing how to use well-known raster functions * guide v101 - item2item relationships - added link to REST api showing a table of all possible relationship types * bug fixes for NYC taxi sample notebook * added install instructions from pro 1.4 * guide - getting started - name changes * guide - API overview - updated release notes for v1.0.1, naming changes * guide - 03 - naming changes * guide - 04 - naming changes * guide - 07 - naming changes * guide - landing page - naming changes * samples - naming changes * samples - added credentials * samples - switched to forward slash. Removed redundant thumbnail images * apidoc update * V101 publish packages & clone samples (#77) * content and notebook demonstrating publishing of packages as web layers * added sample showing how to publish packages as web layers * updated clone portals sample * minor doc update - gis.map (#79) * content and notebook demonstrating publishing of packages as web layers * added sample showing how to publish packages as web layers * updated clone portals sample * fix for #76 * from merge of dev with master - dev summit cut * remove old folder * Fix language detection for this repo * Change repo language to Python * Update README.md * Update README.md * UC 2017 tech sessions and demo theater presentations * UC 2017 Tech Sessions and Demo Theater sessions * UC2017 Tech Sessions and Demo Theater sessions * Updatye raster analysis sample to use pythonic raster functions instead of json * advanced scripting - features, geocoding, network * added my talks for Python API for developers * updated auth page for v1.2 * Updated OAuth 2.0 authorization steps * minor tweaks * added guide pages for GIS collaborations (#127) * finished writing server module guide * server mod doc proofed * portal admin guide - ver 3 * portal admin guide - ver 4 * portal admin guide - ver 5 - proofed * guide showing customizing portal UX * minor
rohitgeo
pushed a commit
that referenced
this pull request
Aug 15, 2017
* added geocoding module introduction. (#124) * Auth page updates (#126) * Use ReadTheDocs theme * api doc updates * gis doc update * clean up doc * bug fixes in clone portal sample * V101 updates (#75) * v101 added a topic on masking passwords to the 'working with auth schemes' page * guide v101 added section showing how to use well-known raster functions * guide v101 - item2item relationships - added link to REST api showing a table of all possible relationship types * bug fixes for NYC taxi sample notebook * added install instructions from pro 1.4 * guide - getting started - name changes * guide - API overview - updated release notes for v1.0.1, naming changes * guide - 03 - naming changes * guide - 04 - naming changes * guide - 07 - naming changes * guide - landing page - naming changes * samples - naming changes * samples - added credentials * samples - switched to forward slash. Removed redundant thumbnail images * apidoc update * V101 publish packages & clone samples (#77) * content and notebook demonstrating publishing of packages as web layers * added sample showing how to publish packages as web layers * updated clone portals sample * minor doc update - gis.map (#79) * content and notebook demonstrating publishing of packages as web layers * added sample showing how to publish packages as web layers * updated clone portals sample * fix for #76 * from merge of dev with master - dev summit cut * remove old folder * Fix language detection for this repo * Change repo language to Python * Update README.md * Update README.md * UC 2017 tech sessions and demo theater presentations * UC 2017 Tech Sessions and Demo Theater sessions * UC2017 Tech Sessions and Demo Theater sessions * Updatye raster analysis sample to use pythonic raster functions instead of json * advanced scripting - features, geocoding, network * added my talks for Python API for developers * updated auth page for v1.2 * Updated OAuth 2.0 authorization steps * minor tweaks * added guide pages for GIS collaborations (#127) * finished writing server module guide * server mod doc proofed * API REF doc updates for v1.2.1
rohitgeo
pushed a commit
that referenced
this pull request
Aug 30, 2017
* added geocoding module introduction. (#124) * Auth page updates (#126) * Use ReadTheDocs theme * api doc updates * gis doc update * clean up doc * bug fixes in clone portal sample * V101 updates (#75) * v101 added a topic on masking passwords to the 'working with auth schemes' page * guide v101 added section showing how to use well-known raster functions * guide v101 - item2item relationships - added link to REST api showing a table of all possible relationship types * bug fixes for NYC taxi sample notebook * added install instructions from pro 1.4 * guide - getting started - name changes * guide - API overview - updated release notes for v1.0.1, naming changes * guide - 03 - naming changes * guide - 04 - naming changes * guide - 07 - naming changes * guide - landing page - naming changes * samples - naming changes * samples - added credentials * samples - switched to forward slash. Removed redundant thumbnail images * apidoc update * V101 publish packages & clone samples (#77) * content and notebook demonstrating publishing of packages as web layers * added sample showing how to publish packages as web layers * updated clone portals sample * minor doc update - gis.map (#79) * content and notebook demonstrating publishing of packages as web layers * added sample showing how to publish packages as web layers * updated clone portals sample * fix for #76 * from merge of dev with master - dev summit cut * remove old folder * Fix language detection for this repo * Change repo language to Python * Update README.md * Update README.md * UC 2017 tech sessions and demo theater presentations * UC 2017 Tech Sessions and Demo Theater sessions * UC2017 Tech Sessions and Demo Theater sessions * Updatye raster analysis sample to use pythonic raster functions instead of json * advanced scripting - features, geocoding, network * added my talks for Python API for developers * updated auth page for v1.2 * Updated OAuth 2.0 authorization steps * minor tweaks * added guide pages for GIS collaborations (#127) * finished writing server module guide * server mod doc proofed * updates for v122
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a geocoding module notebook to be consistent with structure of guide, and added info to the apidoc for geocoding.