B018 wrongly detects inline variable or attribute docstrings

[xqt]

Having an inline attribute doc string or a module variable docstring, it is wrongly marked as B018 (sample from sphinx doc):

module_level_variable2 = 98765
"""int: Module level variable documented inline.

The docstring may span multiple lines. The type may optionally be specified
on the first line, separated by a colon.
"""

[PhilippSelenium]

Can confirm.

[Mischback]

Can confirm, too.

You may see a failing Github Action run here: https://github.com/Mischback/django-calingen/actions/runs/1514981629

# FLAKE 8 SETTINGS regarding plugin configuration

# Activate rules by plugins
extend-select =
    # flake8-assertive
    A,
    # flake8-bugbear
    B, B902, B903,
    # pydocstyle (by flake8-docstrings)
    D,
    # flake8-django
    DJ, DJ10, DJ11,

The full flake8 configuration can be found here: https://github.com/Mischback/django-calingen/blob/interfaces/.flake8

As flake8-bugbear is run by flake8 pre-commit hook, this is the relevant part of my pre-commit configuration:

repos:
  # ... cut ...
  # flake8 (linting)
  - repo: https://github.com/PyCQA/flake8
    rev: 4.0.1
    hooks:
      - id: flake8
        additional_dependencies: [flake8-bugbear, flake8-docstrings, flake8-django, flake8-assertive]

The full pre-commit configuration can be found here: https://github.com/Mischback/django-calingen/blob/interfaces/.pre-commit-config.yaml

[henzef]

B018 is also triggered for multi-line strings that are used as a comment aside from docstrings. Is this behaviour intentional?

[oliver-sanders]

For info, attribute docstrings aren't a Python feature, however, are widely used and supported by the Sphinx documentation system via autodoc.

[cooperlees]

Damn. Sorry all, definitely missed this and it's not intended. A PR adding a unit test showing we no longer flag this will definitely be accepted. I'll try get to it but welcome to beat me to it!

cc: @kasium - Checks creator to see if they can workout a fix quicker than I :D

[kasium]

@cooperlees I'm very sorry for that. As a fast workaround, let's just skip strings and work with anything else. Then we can look for a better solution

[kasium]

Hi all. I created #209