Inconsistent formatting of docstrings

[trickeydan]

In some places we have docstrings in this style:

def automatic_bee_handler(self, species):
    """ Handles the bees automatically """
   species..activate_all_bees()

In other places we have this style of docstring:

def automatic_bee_handler(self, species):
    """
    Handles the bees automatically
    """
   species..activate_all_bees()

It's probably worth being consistent with this.

[PeterJCLaw]

We have flake8-docstrings linting our docstrings here, are there any cases where the format is different to what you'd want and where changing it still passes linting?

I'm open to changing the linting configuration if we want to, though I suggest that we check first that the linting is behaving as it is currently configured (otherwise the linter isn't helping at all and it's not a config issue).

[PeterJCLaw]

So it turns out that the current config disables the check in question, apparently due to a bug. There's no mention of whether the bug has been reported (I blame whoever made that change 😞 for not reporting upstream), though we do know what the bug was.

We should check whether a recent flake8-docstrings still has the issue either report it upstream or re-enable the check.

[trickeydan]

Seeing as flake8-docstrings has not been updated since 4th Jan, I doubt the issue has been fixed