qgis/QGIS-Documentation

Fill expression functions docs with visual examples

Open

#7,802 opened on Sep 24, 2022

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (1,037 forks)auto 404
ExpressionsShowcase/Screenshotsgood first issue

Repository metrics

Stars
 (607 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Follow the steps in the issue to add visual examples to the geometry functions documentation: fill images list.json, add images, optionally run populate expressions list.py, and submit a pull request.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80