Skip to content

Modernize docstrings & make everything consistent #1565

@dgw

Description

@dgw

This whole initiative started with #1563, but I only dealt with one file in that PR.

The whole public API (at least) should get an overhaul before we release 7.0, to make sure the API docs are really nice and easy to use. We only use Sphinx magic like :param: descriptions in a few places so far, and it would be awesome to have those everywhere.

Here's the important (public) stuff:

This stuff is more internal, and it's not as important to get done in time for 7.0, but it would still be great to have nice, consistent docs for at some point:

Note that even though I assigned this issue to myself, anyone should feel free to tackle something on this list in a PR. The review process might be tedious (I'm picky about grammar), but it will all be worth it when we release Sopel 7 and bump the website to show the shiny modern API documentation in all its glory! (Edited to add: We have a preview site which shows the updated docs, but it's not always quite caught up on the latest master changes. We're trying to be nice to our site deployment service by forcing rebuilds somewhat infrequently, since they host us for free.)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions