arcgis-python-api icon indicating copy to clipboard operation
arcgis-python-api copied to clipboard

Updates to enrich guide examples

Open knu2xs opened this issue 2 years ago • 5 comments

All I really did was update the workflows to highlight how to use the udpated methods (introspection and enrich) using the same data as previously used in the prior geoenrichment examples.

@achapkowski, since I have an account in the geosaurus org, I published the data, shared it and changed the data owner to api_data_owner already. The data is exactly the same as the data previously used in the geoenrichment examples.


Checklist

Please go through each entry in the below checklist and mark an 'X' if that condition has been met. Every entry should be marked with an 'X' to be get the Pull Request approved.

  • [x] All imports are in the first cell?
    • [x] First block of imports are standard libraries
    • [x] Second block are 3rd party libraries
    • [x] Third block are all arcgis imports? Note that in some cases, for samples, it is a good idea to keep the imports next to where they are used, particularly for uncommonly used features that we want to highlight.
  • [x] All GIS object instantiations are one of the following?
    • gis = GIS()
    • gis = GIS('home') or gis = GIS('pro')
    • gis = GIS(profile="your_online_portal")
    • gis = GIS(profile="your_enterprise_portal")
  • [x] If this notebook requires setup or teardown, did you add the appropriate code to ./misc/setup.py and/or ./misc/teardown.py?
  • [x] If this notebook references any portal items that need to be staged on AGOL/Python API playground, did you coordinate with a Python API team member to stage the item the correct way with the api_data_owner user?
  • [ ] If the notebook requires working with local data (such as CSV, FGDB, SHP, Raster files), upload the files as items to the Geosaurus Online Org using api_data_owner account and change the notebook to first download and unpack the files.
  • [x] Code simplified & split out across multiple cells, useful comments?
  • [x] Consistent voice/tense/narrative style? Thoroughly checked for typos?
  • [x] All images used like <img src="base64str_here"> instead of <img src="https://some.url">? All map widgets contain a static image preview? (Call mapview_inst.take_screenshot() to do so)
  • [x] All file paths are constructed in an OS-agnostic fashion with os.path.join()? (Instead of r"\foo\bar", os.path.join(os.path.sep, "foo", "bar"), etc.)
  • [x] Is your code formatted using Jupyter Black? You can use Jupyter Black to format your code in the notebook.
  • [x] IF YOU WANT THIS SAMPLE TO BE DISPLAYED ON THE DEVELOPERS.ARCGIS.COM WEBSITE, ping @ mohi9282 so he can add it to the list for the next deploy

knu2xs avatar Jul 27 '22 15:07 knu2xs

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

View / edit / reply to this conversation on ReviewNB

nanaeaubry commented on 2022-08-01T16:40:35Z ----------------------------------------------------------------

jurisdictional areas


View / edit / reply to this conversation on ReviewNB

nanaeaubry commented on 2022-08-01T16:40:36Z ----------------------------------------------------------------

Because we are working with...

Also, although there are three rows displayed below, this is because the variable is included in three Data Collections. --> Rephrase this to something like: The reason there are three rows....


View / edit / reply to this conversation on ReviewNB

nanaeaubry commented on 2022-08-01T16:40:37Z ----------------------------------------------------------------

This is demonstrated in a later example.


@knu2xs I added some comments where I saw typos and things of the sort. Great job on the guides!

I didn't write it everywhere but I find that you use a lot of filler words in some places and the sentences could be more concise. Not sure what level we are expecting users to be at for the guides but I also find it hard to understand all the columns of the dataframes and understand what is important to use and what is just information to know. Hope that makes sense.

nanaeaubry avatar Aug 01 '22 16:08 nanaeaubry

@CMPeng I took the liberty of applying edits to these notebooks.

I don't know if all of them should replace what we currently have. I went through and tested our current guides with 2.1.0 and no major errors were found so it is up to us to see if these new notebooks are worth integrating or not.

nanaeaubry avatar Dec 13 '22 00:12 nanaeaubry

@CMPeng I took the liberty of applying edits to these notebooks.

I don't know if all of them should replace what we currently have. I went through and tested our current guides with 2.1.0 and no major errors were found so it is up to us to see if these new notebooks are worth integrating or not.

Thanks Nanae for reviewing these edits. I would think taking in these replacements will be good, since they are grammatically or syntactically improving our guides. Do you need me to do anything here?

CMPeng avatar Dec 13 '22 18:12 CMPeng

@CMPeng Ok all good I think I will condense them a bit more since they are replacing some common workflows, thanks for the feedback!

nanaeaubry avatar Dec 13 '22 18:12 nanaeaubry

Creating a new PR in my own branch to resolve conflicts

nanaeaubry avatar Dec 14 '22 17:12 nanaeaubry