crossbario / crossbario/autobahn-python
autobahn variant documentation is missing a number of variants
Open
Nobody has claimed this yet.
bug
docs
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 768
- PR merge metrics
- No merged PRs in 30d
Description
As you can see here:
https://github.com/crossbario/autobahn-python/blob/master/setup.py#L258
it lists the following extras:
encryption, scram, nvx, dev, xbr and ui
And none of those are listed at:
https://autobahn.readthedocs.io/en/latest/installation.html
Contributor guide
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
Compare the extras listed around setup.py#L258 with the installation page at autobahn.readthedocs.io/en/latest/installation.html. Document the missing encryption, scram, nvx, dev, xbr, and ui variants there, then verify that all six extras are covered.
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
- Clearly specified
- Newbie friendliness
- 48/100