ES|QL Code examples in the source code documentation

Open

#25 opened on Feb 26, 2026 0 comments 0 reactions 1 assignee View on GitHub

@picandocodigo is already working on this.

Since Feb 26, 2026.

Assessment

This issue has not been assessed yet.

Description

enhancement

Currently reference documentation can be generated with YARD docs in ./doc by running rake yard. Add source code examples to this documentation.
The tests have several good examples which can be used for this task.

Dominant language: Ruby
Stars: 2
Forks: 1
PR merge metrics: No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

Gateway 3.16 Linux install: GPG key URL 404s (public_keys has no "316" entry, falls back to legacy key) Open

user-reported

Difficulty 2/5 1-3 hours Newbie friendliness 85/100

Kong/developer.konghq.com#7316 · Opened Sep 22, 2026
Semantic HTML: Further explain how landmark elements should be used Open

Difficulty 2/5 1-3 hours Newbie friendliness 76/100

TheOdinProject/curriculum#31408 · Opened Sep 21, 2026
URI label indexer writes to _label_tesim instead of _tesim Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 84/100

notch8/utk_knapsack#148 · Opened Sep 21, 2026
`font-gnu-unifont` download link broken Open

Difficulty 1/5 Under an hour Newbie friendliness 78/100

Homebrew/homebrew-cask#288729 · 1 comment · Opened Sep 21, 2026
Test `FileUtils.options_of` Open

Difficulty 2/5 1-3 hours Newbie friendliness 68/100

ruby/fileutils#195 · Opened Sep 21, 2026

More Ruby issues