Skip to content

One blank line required between summary line and description #74

@jorgepiloto

Description

@jorgepiloto

🐞 Problem
Docstrings description are composed by two different parts: a one line summary and a short description. These parts are divided by one blank line.

The following files should be fixed:

src/ansys/stk/core/internal/comutil.py:532:9: D205 1 blank line required between summary line and description
src/ansys/stk/core/internal/marshall.py:751:9: D205 1 blank line required between summary line and description
src/ansys/stk/core/internal/marshall.py:810:9: D205 1 blank line required between summary line and description
src/ansys/stk/core/stkdesktop.py:82:5: D205 1 blank line required between summary line and description
src/ansys/stk/core/stkdesktop.py:128:9: D205 1 blank line required between summary line and description
src/ansys/stk/core/stkdesktop.py:154:9: D205 1 blank line required between summary line and description
src/ansys/stk/core/stkengine/__init__.py:46:5: D205 1 blank line required between summary line and description
src/ansys/stk/core/stkengine/__init__.py:168:9: D205 1 blank line required between summary line and description
src/ansys/stk/core/stkengine/__init__.py:191:13: D205 1 blank line required between summary line and description
src/ansys/stk/core/stkengine/__init__.py:199:13: D205 1 blank line required between summary line and description
src/ansys/stk/core/utilities/colors.py:2:1: D205 1 blank line required between summary line and description
src/ansys/stk/core/utilities/colors.py:87:5: D205 1 blank line required between summary line and description
src/ansys/stk/core/utilities/comobject.py:8:5: D205 1 blank line required between summary line and description
src/ansys/stk/core/vgt.py:35065:5: D205 1 blank line required between summary line and description

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsIssues related to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions