google / google/codeworld

Improved documentation for builtin symbols

Open
#814 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Haskell
Stars
1.3k
Forks
201
PR merge metrics
No merged PRs in 30d

Description

Now that we have more visible documentation in the editor, it's conspicuous how much the documentation is missing for a lot of builtin symbols. It would be good to add documentation (which just means haddock in the codeworld-base module) for all these definitions.

At the same time, I should rewrite the existing documentation to be clearer about function arguments. We should adopt this style for the first sentence of every function:

@thickArc(angle1, angle2, radius, thickness)@ is a @Picture@ of an arc
between the given angles, with the given radius and line thickness.

The documentation can go on to give examples and such, but that first sentence clarifies what each argument means in a precise way.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.