Opened 4 years ago

Closed 4 years ago

#6338 defect closed fixed (fixed)

IResolver docstrings contain broken references

Reported by: Thijs Triemstra Owned by: Richard Wall
Priority: low Milestone:
Component: core Keywords: documentation
Cc: Thijs Triemstra Branch: branches/iresolver-epydocs-6338
branch-diff, diff-cov, branch-cov, buildbot
Author: rwall

Description

r37286 (#4685) introduced lots of new documentation but also many broken C{Deferred} references which should be L{Deferred} instead.

Change History (5)

comment:1 Changed 4 years ago by Richard Wall

Status: new → assigned

Ah. OK. Those @rtype C{Deferred} references were already there. I just moved them from t.n.client.lookup* to t.i.i.IResolver.lookup*

Should be easy to fix though. I'll do it now.

comment:2 Changed 4 years ago by Richard Wall

Author: → rwall
Branch: → branches/iresolver-epydocs-6338

(In [37308]) Branching to 'iresolver-epydocs-6338'

comment:3 Changed 4 years ago by Richard Wall

Keywords: review added
Owner: Richard Wall deleted
Status: assigned → new

Ready for review in log:branches/iresolver-epydocs-6338

  1. Replaces all C{Deferred} references with L{Deferred} references.
  2. Here are the apidocs built from this branch: ​https://buildbot.twistedmatrix.com/builds/apidocs/apidocs-37309.tar.bz2
  3. And I started a ​build

comment:4 Changed 4 years ago by Tom Prince

Keywords: review removed
Owner: set to Richard Wall

Looks good. Please merge.

comment:5 Changed 4 years ago by Richard Wall

Resolution: → fixed
Status: new → closed

(In [37323]) Merge iresolver-epydocs-6338: Fix epydoc links to Deferred in IResolver

Author: rwall Reviewer: tom.prince Fixes: #6338

  • Replace C{Deferred} with L{Deferred} references in IResolver docstrings.
Note: See TracTickets for help on using tickets.