Make it more obvious how to add text
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reading the user guide, advanced guide, and the DivIcon API reference linked in the issue to find the relevant documentation sections. Done means the user guide has a Text section describing recommended ways to add visible text, and relevant API sections include wording that makes text-related examples searchable.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem? Please describe.
I've just started using Folium, and while it is very useful, I have been frustrated by the lack of documentation on how to add text elements - other than marker tooltips and popups, neither of which are initially visible to the user. As far as I can see there is nothing at all in the user guide or advanced guide.
A search for 'text' doesn't seem to point to anything relevant either, except PolyLineTextPath which is for a relatively specialist text case.
From StackOverflow etc. searches, the simplest solution for most cases seems to be to use a DivIcon for most cases. But that is very hidden in the documentation. I can see there are other methods via Leaflet or branca APIs.
Describe the solution you'd like
- Add a Text section to the user guide with recommended ways to add text elements.
- Add a bit of detail including the word 'text' to relevant API sections so they can be found more easily.
Describe alternatives you've considered
n/a
Additional context
n/a
Implementation
folium is maintained by volunteers. Can you help make a PR if we want to implement this feature?
Probably, depending on how complex it is to make docs changes.
- Dominant language
- Python
- Stars
- 7.4k
- Forks
- 2.3k
- Avg merge
- 17h 22m
- Merged PRs (30d)
- 11
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from python-visualization/folium
-
Difficulty 3/5 1-2 days Newbie friendliness 67/100
python-visualization/folium#2278 · 1 comment ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
python-visualization/folium#2259 ·
-
Map output from OSM returns blocked tiles, due to defective request or not following referer-policy Open
Difficulty 3/5 1-2 days Newbie friendliness 55/100
python-visualization/folium#2236 · 5 comments · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 10/100
python-visualization/folium#2219 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
python-visualization/folium#2200 ·
All issues in python-visualization/folium
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
learningequality/ricecooker#747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
run-llama/llama_index#23199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
KhronosGroup/glTF-Blender-IO#2769 ·