python-visualization / python-visualization/folium
Make it more obvious how to add text
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 7.4k
- Forks
- 2.3k
- Ø Merge
- 17 Std. 22 Min.
- Gemergte PRs (30 T.)
- 11
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, den im Issue verlinkten User Guide, Advanced Guide und die DivIcon API-Referenz zu lesen, um die relevanten Dokumentationsabschnitte zu finden. Erledigt ist die Aufgabe, wenn der User Guide einen Abschnitt „Text“ enthält, der empfohlene Möglichkeiten zum Hinzufügen sichtbaren Textes beschreibt, und die relevanten API-Abschnitte Formulierungen enthalten, mit denen Beispiele zum Thema Text gesucht werden können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 68/100