UrbitGrants

Doccord Compliant Comments in all Generators

In Progress
Bounty
Core Dev

ID

B0231

Date

January 31, 2023

Grantee(s)

~napnyl-nortuc

Overview

The base desk comes with a variety of generators and threads that are useful for debugging and development. Documentation and usage guidance for these is scattered between inline comments (accessible via the +help generator) and operators.urbit.org We propose to take advantage of the newly released doccords feature to consolidate the documentation and provide an introduction to the doccords utility for users.

Implementation

For every "dojo tool" covered in the docs, move the documentation into the source code in accordance with the doccord style guide.

Rewrite the +help generator to display the relevant doccords.

Currently you need to do the following to see inline doccords.

=file -build-file %/path/to/file/hoon
# file

This should be improved to be:

+help %example-generator
> formatted comments

Payment

1 Star