Use Traits doc-comments to improve API docs
Open
component: documentation
- Dominant language
- Python
- Stars
- 115
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
The autogenerated API documentation for Pyface is missing a number of key details because some (many? all?) of its traits are documented with a regular `# comment` instead of a `#: traits doc-comment` that can be picked up by the trait documenter. It would be nice to fix that.
The particular instance that I ran into was trying to refer to `IEditor.obj` from 3rd party documentation (via intersphinx), but there are likely many others.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.