enthought / enthought/pyface

Ensure that all code snippets and examples are working

Open
#610 0 comments 0 reactions 1 assignee Claimed by @aaronayres35 View on GitHub
component: documentation
Dominant language
Python
Stars
115
Forks
54
PR merge metrics
No merged PRs in 30d

Description

code snipperts - https://github.com/enthought/pyface/tree/master/docs/source/examples
examples - https://github.com/enthought/pyface/tree/master/examples

The focus of this issue is to ensure that all external-facing code examples in traitsui are working as expected (on Qt and Wx toolkit backends if both are supported). Specifically,

- [ ] the code runs without any errors. Any errors should be fixed.
- [ ] the code don't raise any warnings or messages on the commandline. Any warnings/messages need to be debugged and fixed or documented in issues.
- [ ] the code itself is well documented e.g. docstrings in the module, classes and functions/methods.

Note that moving/refactoring the code or adding new code is out of scope for this issue

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.