twisted / twisted/twisted

Document `twist` application runner

Open
#8,942 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

core enhancement new priority-normal
Dominant language
Python
Stars
6k
Forks
1.2k
Avg merge
2d 10h
Merged PRs (30d)
10

Description

derwolfe's avatar @derwolfe reported
Trac ID trac#8942
Type enhancement
Created 2016-12-12 19:38:46Z

Add narrative documentation detailing when, how, and why to use the new twist application runner.

Searchable metadata
trac-id__8942 8942
type__enhancement enhancement
reporter__derwolfe derwolfe
priority__normal normal
milestone__None None
branch__ 
branch_author__ 
status__new new
resolution__None None
component__core core
keywords__None None
time__1481571526379301 1481571526379301
changetime__1481826776674726 1481826776674726
version__None None
owner__None None
cc__wsanchez

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

Start by locating the twist application runner and the project's existing documentation structure. Document when, how, and why to use twist, using the surrounding documentation as a guide; done means the runner has a clear narrative guide covering those three points.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.