enthought / enthought/enable

Demos should have descriptive doc strings

Open
#493 0 comments 0 reactions 0 assignees View on GitHub
component: documentation
Dominant language
C
Stars
97
Forks
45
PR merge metrics
No merged PRs in 30d

Description

Once #436 is addressed, the examples will be available via `etsdemo`. The `etsdemo` application has a large central pane for displaying text about the demo which is directly pulled for the demos docstring. It would be helpful for all demos to provide at least a brief description of what they are about in a docstring.

Note that some of the demos already contain useful docstrings.

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.