aspl-lang/aspl

stdlib: use more doc comments

Open

#8 opened on Feb 11, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C (6 forks)auto 404
documentationenhancementgood first issue

Repository metrics

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

Description

I think the title says it all - most of the standard library currently isn't properly documented.

Contributor guide

Research direction
Identify standard library files missing doc comments and add them following the existing documentation style.
Tech stack
c
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
CGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85