gleam-lang/gleam

Surface supported target in the generated docs

Open

#3,684 opened on Oct 10, 2024

View on GitHub
 (0 comments) (3 reactions) (0 assignees)Rust (21,417 stars) (960 forks)batch import
help wanted

Description

Since the compiler already knows the target where each function can run it would be nice if this information could be surfaced in the generated documentation as well

Contributor guide

Tech stack
rusthtml
Domain
documentationdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
understanding of Gleam compiler internalsfamiliarity with documentation generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests that the compiler's knowledge of which targets (e.g., Erlang, JavaScript) each function supports be included in generated documentation. To implement this, one would need to locate where target information is stored in the compiler's abstract syntax tree or type system, and then modify the doc generation code (likely in `compiler core/src/docs.rs` or similar) to emit this information. The existing documentation generation pipeline should be studied to understand how function annotations are rendered. No linked PRs or comments provide additional guidance, so maintainer input may be needed to clarify the desired format.