Skip to content

Typo Correction and Function Description Update #5

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Typo Correction and Function Description Update #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd26354
Fix typo
kaddynator Aug 30, 2021
3a80683
Additional Function Description
kaddynator Aug 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions notebooks/advanced_functionality.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,10 +274,10 @@
"source": [
"The function `polygon_to_placekeys()` generates the set of Placekeys which cover a given polygon. This set is split into two disjoint subsets:\n",
"\n",
"* **interior**: Placekeys with 100% of their area contained in the polygon,\n",
"* **boundary**: Placekeys with more than 0% but less tahn 100% of their area contained in the polygon.\n",
"* **Interior**: Placekeys with 100% of their area contained in the polygon,\n",
"* **Boundary**: Placekeys with more than 0% but less than 100% of their area contained in the polygon.\n",
" \n",
"There is an optional parameter for this function, `include_touching`, which when `True` will include Placekeys that intersect the polygon, but have 0% of their area contained in the polygon (e.g. they only share boundary points). In case you are working with polygons specified by WKTs or GeoJSONs, there are equivalent functions for those input types (`wkt_to_placekeys()` and `geojson_to_placekeys()`)."
"There is an optional parameter for this function, `include_touching`, when set to `True` will include Placekeys that intersect the polygon, but have 0% of their area contained within the polygon (e.g. they only share boundary points). In case you are working with polygons specified by WKTs or GeoJSONs, there are equivalent functions for those input types (`wkt_to_placekeys()` and `geojson_to_placekeys()`)."
]
},
{
Expand Down Expand Up @@ -339,6 +339,8 @@
" \"\"\"\n",
" :param placekey_values: A list of Placekey strings\n",
" :param zoom_start: Folium zoom level. 18 is suitable for neighboring resolution 10 H3s.\n",
" :hex_color: Color of the polygon marker on the folium map\n",
" :weight: Width in pixels of the polygon \n",
" :folium_map: A Folium map object to add the Placekeys to\n",
" :labels: Whether or not to add labels for Placekeys\n",
" :return: a Folium map object\n",
Expand Down Expand Up @@ -705,6 +707,7 @@
}
],
"metadata": {
"hide_input": false,
"kernelspec": {
"display_name": "Python 3",
"language": "python",
Expand All @@ -720,7 +723,20 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.5"
"version": "3.7.6"
},
"toc": {
"base_numbering": 1,
"nav_menu": {},
"number_sections": true,
"sideBar": true,
"skip_h1_title": false,
"title_cell": "Table of Contents",
"title_sidebar": "Contents",
"toc_cell": false,
"toc_position": {},
"toc_section_display": true,
"toc_window_display": false
}
},
"nbformat": 4,
Expand Down