Thread: [Docutils-develop] [docutils:bugs] #351 The docstring of Reader class is wrong

---

** [bugs:#351] The docstring of Reader class is wrong**

**Status:** open
**Group:** Default
**Created:** Sat Sep 29, 2018 05:23 AM UTC by Takeshi KOMIYA
**Last Updated:** Sat Sep 29, 2018 05:23 AM UTC
**Owner:** nobody


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.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

- **status**: open --> closed-fixed
- **Comment**:

Fixed in r8237. Thanks for reporting.



---

** [bugs:#351] The docstring of Reader class is wrong**

**Status:** closed-fixed
**Group:** Default
**Created:** Sat Sep 29, 2018 05:23 AM UTC by Takeshi KOMIYA
**Last Updated:** Sat Sep 29, 2018 05:23 AM UTC
**Owner:** nobody


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.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.