python-visualization / python-visualization/folium
Make it more obvious how to add text
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 7.4k
- Forks
- 2.3k
- Merge moyen
- 17 h 22 min
- PR mergées (30 j)
- 11
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par lire le guide utilisateur, le guide avancé et la référence de l’API DivIcon liés dans l’issue afin de trouver les sections pertinentes de la documentation. C’est terminé lorsque le guide utilisateur contient une section « Text » décrivant les méthodes recommandées pour ajouter du texte visible, et que les sections pertinentes de l’API incluent des formulations permettant de rechercher des exemples liés au texte.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 68/100