Skip to content

Missing docstring in public module #69

@jorgepiloto

Description

@jorgepiloto

🐞 Problem
One of the requirements of code style checkers is that all Python modules should contain a docstring at the very top of the file.

Currently, the following files are missing such docstring:

src/ansys/stk/core/graphics.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/internal/coclassutil.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/internal/comutil.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/internal/dataanalysisutil.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/internal/eventutil.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/internal/marshall.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/internal/stkxinitialization.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/internal/timerutil.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/stkdesktop.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/stkengine/tkcontrols.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/stkobjects/astrogator.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/stkobjects/aviator/matlab.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/stkutil.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/stkx.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/uiapplication.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/uicore.py:1:1: D100 Missing docstring in public module
src/ansys/stk/core/vgt.py:1:1: D100 Missing docstring in public module

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