Menu

#351 The docstring of Reader class is wrong

closed-fixed
nobody
None
5
2020-03-03
2018-09-29
No

It seems the docstring of Reader class is wrong. There are no longer scan() method.

class Reader(Component):

    """
    Abstract base class for docutils Readers.

    Each reader module or package must export a subclass also called 'Reader'.

    The two steps of a Reader's responsibility are `scan()` and
    `parse()`.  Call `read()` to process a document.
    """

I don't know parse() is a responsibility of Reader. But it should be updated.

Discussion

  • Günter Milde

    Günter Milde - 2018-11-21
    • status: open --> closed-fixed
     
  • Günter Milde

    Günter Milde - 2018-11-21

    Fixed in r8237. Thanks for reporting.

     

Log in to post a comment.

MongoDB Logo MongoDB