Opened 11 years ago

Closed 11 years ago

#2702 defect closed duplicate (duplicate)

twisted.words.xish.yappsrt.Scanner.__init__ is not proper epytext

Reported by: therve Owned by:
Priority: highest Milestone:
Component: words Keywords:
Cc: Jean-Paul Calderone, ralphm, therve Branch:
Author:

Description

It broke the documentation builbot. Following patch correct this:

Index: twisted/words/xish/yappsrt.py
===================================================================
--- twisted/words/xish/yappsrt.py       (revision 20510)
+++ twisted/words/xish/yappsrt.py       (working copy)
@@ -80,10 +80,10 @@
                        file=None,filename=None,stacked=False):
                """Initialize the scanner.

-               Parameters:
-                 patterns : [(terminal, uncompiled regex), ...] or None
-                 ignore : {terminal:None, ...}
-                 input : string
+               Parameters::
+                - patterns : [(terminal, uncompiled regex), ...] or None
+                - ignore : {terminal:None, ...}
+                - input : string

                If patterns is None, we assume that the subclass has
                defined self.patterns : [(terminal, compiled regex), ...].

Change History (3)

comment:1 Changed 11 years ago by Jean-Paul Calderone

Cc: Jean-Paul Calderone added

This might be the most appropriate short-term solution. However, this isn't our code and I don't think we should fork it. Excluding it from the API documentation might be a better solution, but I don't know if pydoctor can be made to do that.

comment:2 Changed 11 years ago by ralphm

Cc: ralphm therve added
Component: corewords
Keywords: review removed
Resolution: duplicate
Status: newclosed

Damn duplicates. See my comment at #2701.

comment:3 Changed 7 years ago by <automation>

Owner: Glyph deleted
Note: See TracTickets for help on using tickets.