jaraco / irc

Full-featured Python IRC library for Python.
MIT License
392 stars 87 forks source link

fix rendering of code samples in documentation #178

Closed larsks closed 3 years ago

larsks commented 3 years ago

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.

jaraco commented 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:

I think I'd prefer (2) or (4), but I welcome you to explore the options.

larsks commented 3 years ago

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.

jaraco commented 3 years ago

Fantastic! Thanks for the contrib.