Run code in examples in Beam's Pydoc
- Dominant language
- Java
- Stars
- 8.7k
- Forks
- 4.7k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 196
Description
We have the Beam Pydoc set up, and some functions have examples written into their documentaztion, however we do not run the examples that we express in Pydoc.
This work item consists in improving the Pydoc for Apache Beam to run examples, adding some examples, and reformatting any existing examples / existing Pydoc that needs to be better expressed for Beam.
Imported from Jira [BEAM-14090](https://issues.apache.org/jira/browse/BEAM-14090). Original Jira may contain additional context.
Reported by: pabloem.
Contributor guide
Research direction
Start by locating Beam's Pydoc setup and how its documentation examples are represented. Determine how examples can be executed, then add or reformat examples as needed so the Pydoc examples run successfully and the resulting documentation is clearer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100