Add documentation examples for fixme

[julthep]

Co-authored-by: Vladyslav Krylasov [email protected]

Type of Changes

	Type
✓	📜 Docs

Description

Add documentation examples for fixme

Refs #5953

[Pierre-Sassoulas]

Yeah, the check is that dumb 😄

[Pierre-Sassoulas]

I added work in progress because it seems there's an issue with the disable of fixme.

disable-next:

# pylint: disable-next=fixme
# TODO: We really need to fix this bug!

************* Module a
a.py:2:0: I0011: Locally disabling fixme (W0511) (locally-disabled)
a.py:2:1: W0511: TODO: We really need to fix this bug! (fixme)
a.py:2:0: I0021: Useless suppression of 'fixme' (useless-suppression)

Disabling does not work yet we get an useless suppression.

disable:

# TODO: We really need to fix this bug! # pylint: disable=fixme

************* Module a
a.py:2:0: I0011: Locally disabling fixme (W0511) (locally-disabled)
a.py:2:0: I0021: Useless suppression of 'fixme' (useless-suppression)

Disabling does work but we get an useless suppression.

[DanielNoord]

Issues fixed in #7144 which supersedes this PR. Thanks for the initial work @julthep!