Closed larsks closed 3 years ago
Thanks for the contrib. You may have noticed that the tests execute code in docstrings, and if that code doesn't execute cleanly, then the tests fail. That's why the tests for this PR are failing. There are a few options:
# +doctest:skip
(or similar). Great for one line, but not great for a lot of testsconftest.py
or similarI think I'd prefer (2) or (4), but I welcome you to explore the options.
I've rewritten the docs to use rst code-block
directives. I think the amount of boilerplate necessary to make the code runnable would negatively impact the usefulness of the documentation.
Fantastic! Thanks for the contrib.
The code samples in the docstrings of the irc.connection module were not rendering properly in the generated output. This commit adds the necessary syntax so that they render as code.