map.rst doumentation added #554
Open
Conversation
This file contains 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
davidwagner
reviewed
Sep 12, 2022
| .. autosummary:: | ||
| :toctree: _autosummary | ||
|
|
||
| _FoliumWrapper.draw |
There was a problem hiding this comment.
What is the rationale for including docs on _FoliumWrapper? Normally classes that start with an underscore are not intended to be a primary part of the visible API?
davidwagner
reviewed
Sep 12, 2022
| .. autosummary:: | ||
| :toctree: _autosummary | ||
|
|
||
| Map.__getItem__ |
There was a problem hiding this comment.
Should methods starting with an _ be surfaced here?
davidwagner
reviewed
Sep 12, 2022
| .. autosummary:: | ||
| :toctree: _autosummary | ||
|
|
||
| Map._set_folium_wrap |
There was a problem hiding this comment.
Should this method be made visible in this documentation?
davidwagner
reviewed
Sep 12, 2022
|
|
||
| **Summary of Marker Class** | ||
|
|
||
| The Marker class instantiates a marker that is displayed with _FoliumWrapper's simple_marker method. The color of the marker can either be chosen from [‘red’, ‘blue’, ‘green’, ‘purple’, ‘orange’, ‘darkred’,'lightred’, ‘beige’, ‘darkblue’, ‘darkgreen’, ‘cadetblue’, ‘darkpurple’, |
There was a problem hiding this comment.
The fact that it uses _FoliumWrapper doesn't seem like a critical thing to document, that users need to understand.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Formatted map.rst to provide documentation to the maps.py methods similar to the tables.rst. Summarizes the purpose of each function in the classes in maps.py to separates it into creation, mutation, accessing, and transformation.