SyntaxErrors in documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
The examples in the documentation contain SyntaxError as they are still written for Python 2. This may erroneously make people believe posttroll is a Python 2 package, whereas in reality it is already Python 3 only (see #28). There are some other formatting problems in the documentation as well, for example:
from posttroll.subscriber import Subscribe
with Subscribe("a_service", "counter",) as sub:
for msg in sub.recv():
print msg
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the documentation for the shown posttroll.subscriber example and other Python 2 syntax, starting with the code snippets that use print statements or have formatting issues. Done means the examples are valid Python 3 and the documented formatting is corrected throughout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100