Skip to content

Improve/complete/generate documentation #7

Description

@lePereT

ENHANCEMENT

I've tried to document some of the fibers modules (timer, sched, 'fiberandchannel`) using the LDoc format. 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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions