Ticket #5888 enhancement closed duplicate

Opened 10 months ago

Last modified 7 months ago

Twisted Words examples: Add documentation inside each example

Reported by: luper Owned by: luper
Priority: low Milestone:
Component: words Keywords: easy documentation
Cc: ralphm Branch:
Author: Launchpad Bug:

Description

 http://twistedmatrix.com/documents/current/words/examples/index.html

Add documentation inside each example describing how to run it and what it does See the comment block at the top of minchat.py for an example

Attachments

Ticket5888TwistedWordsExamplesAddDocumentation.patch Download (3.9 KB) - added by anitgen 7 months ago.
I have added docstrings with To run script descriptions
Ticket5888TwistedWordsExamplesAddDocumentationSecondTry.patch Download (3.3 KB) - added by anitgen 7 months ago.
I updated the trunk first then created this patch. This is my second try with the updated trunk.

Change History

1

Changed 10 months ago by DefaultCC Plugin

  • cc ralphm added

2

Changed 10 months ago by luper

  • status changed from new to assigned
  • owner set to luper

3

Changed 10 months ago by luper

  • keywords easy added

4

Changed 10 months ago by thijs

  • keywords easy, documentation added; easy removed

Changed 7 months ago by anitgen

I have added docstrings with To run script descriptions

Changed 7 months ago by anitgen

I updated the trunk first then created this patch. This is my second try with the updated trunk.

5

Changed 7 months ago by ashfall

  • keywords easy added; easy, removed
  • status changed from assigned to closed
  • resolution set to duplicate

Duplicate of #5589, attaching the patch to #5589.

anitgen, Thanks for looking into the ticket. Note that once you submit a patch, you need to add the "review" keyword to indicate that someone should review your changes (might help if you read Twisted's ReviewProcess). Also, please add a news fragment along with your patch.

Note: See TracTickets for help on using tickets.