qgis/QGIS-Documentation

Fill expression functions docs with visual examples

Open

#7.802 aberto em 24 de set. de 2022

Ver no GitHub
 (2 comments) (1 reaction) (0 assignees)Python (1.037 forks)auto 404
ExpressionsShowcase/Screenshotsgood first issue

Métricas do repositório

Stars
 (607 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Siga as etapas no problema para adicionar exemplos visuais à documentação de funções geométricas: preencha o images list.json, adicione imagens, opcionalmente execute o script populate expressions list.py e envie um pull request.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80