Ticket #5447 defect closed fixed

Opened 17 months ago

Last modified 14 months ago

twisted.test was removed from /documents/ but links still point at twisted.test.proto_helpers.html

Reported by: JB Owned by: thijs
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: oubiwann, thijs, jesstess Branch: branches/test-apidocs-5447
Author: thijs Launchpad Bug:

Description

 http://twistedmatrix.com/documents/current/core/howto/trial.html links to the twisted.test.proto_helpers and StringTransport docs at the (non-functioning) url  http://twistedmatrix.com/documents/11.1.0/api/twisted.test.proto_helpers.html

Change History

1

Changed 17 months ago by DefaultCC Plugin

  • cc oubiwann added

2

Changed 17 months ago by thijs

  • cc thijs added
  • component changed from website to core

There's also a typo in the TypeError used in the calculus/base_3.py trial howto example.

raise TypeError("Coudln't coerce arguments to integers: %s" % args)

3

Changed 14 months ago by thijs

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

I suggest getting rid of those API links because the tests aren't included in the API documentation.

4

Changed 14 months ago by thijs

  • branch set to branches/test-apidocs-5447
  • branch_author set to thijs

(In [33735]) Branching to 'test-apidocs-5447'

5

Changed 14 months ago by thijs

(In [33736]) Fix links and typo in example of trial howto, refs #5447

6

Changed 14 months ago by thijs

  • owner thijs deleted
  • status changed from assigned to new
  • keywords documentation, review added; documentation removed

7

Changed 14 months ago by jesstess

  • owner set to jesstess

8

Changed 14 months ago by jesstess

  • keywords documentation added; documentation, review removed
  • owner changed from jesstess to thijs
  • cc jesstess added

Looks great, please merge!

9

Changed 14 months ago by thijs

  • status changed from new to closed
  • resolution set to fixed

Fixed in r33776.

10

Changed 14 months ago by ralphm

That should be r33766.

I also want to note that this module is excluded because pydoctor has Twisted-specific exclusions which happen to include all packages named 'test'. These can be found in  pydoctor.twistedmodel.TwistedSystem as pointed to by our  documentation build configuration.

Maybe we should augment/move that to the Twisted repository so that it does not exclude twisted.test.proto_helpers.

11

Changed 14 months ago by exarkun

We should move all of the helper code from proto_helpers out of twisted.test (note "move" is a complicated verb, it involves making sure the APIs make sense and writing documentation and unit tests).

Note: See TracTickets for help on using tickets.