Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#5447 defect closed fixed (fixed)

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
(diff, github, buildbot, log)
Author: thijs Launchpad Bug:

Description

Change History (11)

comment:1 Changed 3 years ago by DefaultCC Plugin

  • Cc oubiwann added

comment:2 Changed 3 years 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)

comment:3 Changed 3 years ago by thijs

  • Owner set to thijs
  • Status changed from new to assigned

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

comment:4 Changed 3 years ago by thijs

  • Author set to thijs
  • Branch set to branches/test-apidocs-5447

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

comment:5 Changed 3 years ago by thijs

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

comment:6 Changed 3 years ago by thijs

  • Keywords review added
  • Owner thijs deleted
  • Status changed from assigned to new

comment:7 Changed 3 years ago by jesstess

  • Owner set to jesstess

comment:8 Changed 3 years ago by jesstess

  • Cc jesstess added
  • Keywords review removed
  • Owner changed from jesstess to thijs

Looks great, please merge!

comment:9 Changed 3 years ago by thijs

  • Resolution set to fixed
  • Status changed from new to closed

Fixed in r33776.

comment:10 Changed 3 years 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.

comment:11 Changed 3 years 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.