Open llucax opened 7 months ago
We need to avoid showing boilerplate code when we want to just quickly show an abstract example in the docs, but we still want to make sure that code works, so it needs the boilerplate to pass, for example, pylint checks.
pylint
Use [frequenz-pymdownx-superfences-filter-lines(https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python) to select which lines to show in examples.
frequenz-pymdownx-superfences-filter-lines
Example:
llucax
commented
4 months ago
What's needed?
We need to avoid showing boilerplate code when we want to just quickly show an abstract example in the docs, but we still want to make sure that code works, so it needs the boilerplate to pass, for example,
pylintchecks.Proposed solution
Use [
frequenz-pymdownx-superfences-filter-lines(https://github.com/frequenz-floss/frequenz-pymdownx-superfences-filter-lines-python) to select which lines to show in examples.