prestodb/presto

Ensure all functions and operators have examples

Open

#19830 opened on Jun 8, 2023

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Java (15,558 stars) (5,240 forks)batch import
docsgood first issue

Description

In the Functions and Operators section, all functions and operators should have examples so that users can conveniently copy a working example into their query editor.

Going forward, we should ensure that new functions also include both documentation and a working example.

Contributor guide

Tech stack
javasql
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic SQL knowledgePresto documentation style guideLocal development environment for documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the current Functions and Operators documentation at https://prestodb.io/docs/current/functions.html to identify functions and operators lacking examples. Look at existing examples for formatting and syntax. Consider contributing examples for a single function first, and check issue comments for any guidelines or prioritization.