jangala-dev / jangala-dev/lua-fibers

Improve/complete/generate documentation

Open
#7 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Lua
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

**ENHANCEMENT**

I've tried to document some of the fibers modules (`timer`, `sched`, 'fiber` and `channel`) using the [LDoc format](https://stevedonovan.github.io/ldoc/). This will allow for the auto-generation of documentation and for contextual help in code editors.

However:
* the LDoc generation hasn't been tested
* the documentation isn't complete, and
* I'm not sure that the approach I've chosen (types I've created, etc) is the best way

This documentation task will require a good knowledge of the codebase and would be good to be done by someone other than me alongside code review.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the existing LDoc annotations for the timer, sched, fiber, and channel modules, then try generating the documentation with LDoc. Check whether generation works, identify incomplete module documentation, and assess whether the chosen types and approach accurately reflect the codebase.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.