crossbario / crossbario/autobahn-python

py3.5+: use await/async in docs and examples

Open
#1,289 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs enhancement examples Python 3
Dominant language
Python
Stars
2.5k
Forks
768
PR merge metrics
No merged PRs in 30d

Description

Now that we have deprecate support for python < 3.5, we should use & promote the async/await syntax in:

  • documentation
  • examples

Docs are living here, are writeen in ReST, can be build manually (using make docs) and are published automatically (from Travis) to RTD (here)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the documentation under docs and the repository's examples to find Python versions of async code that still use older syntax. Run make docs to verify the ReST documentation builds successfully; done means the relevant documentation and examples promote async/await syntax without breaking the documentation build.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.