qgis/QGIS-Documentation

Fill expression functions docs with visual examples

Ouverte

#7 802 ouverte le 24 sept. 2022

Voir sur GitHubGuide contributeur
 (2 commentaires) (1 réaction) (0 personne assignée)Python (1 037 forks)auto 404
ExpressionsShowcase/Screenshotsgood first issue

Métriques du dépôt

Stars
 (607 étoiles)
Métriques de merge PR
 (Merge moyen 9j 17h) (79 PRs mergées en 30 j)

Description

The request is to add visual rendering of the functions (mainly the geometry ones) in the expression chapter. These can be gif or static images showing the expression and the output. For reference, changelogs sometimes provides good references for this. Some functions also have a corresponding algorithm we might have already provided an image for. Worth checking.

To add an image:

  1. Fill the images_list.json file with necessary details (see template in first item)
  2. Load the image(s) if not already in this repository, either in expressions/expression_help/img or processing_algs\*\img folder
  3. (Optional) Execute the populate_expressions_list.py script if you locally have the code repo also. No worries if you do not do this, it will be handled by us.
  4. Submit pull request

Page URL: https://docs.qgis.org/testing/en/docs/user_manual/expressions/functions_list.html#geometry-functions

Guide contributeur

Direction de recherche
Suivez les étapes du problème pour ajouter des exemples visuels à la documentation des fonctions géométriques : remplissez images list.json, ajoutez les images, exécutez éventuellement populate expressions list.py et soumettez une demande de tirage.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80