Skip to content

Missing docstring in public package #70

@jorgepiloto

Description

@jorgepiloto

🐞 Problem
Packages in a Python library are defined as a directory containing an __init__.py file. These files, even if empty, are expected to have a docstring at the very top too.

The following files are missing the docstring:

src/ansys/stk/core/internal/__init__.py:1:1: D104 Missing docstring in public package
src/ansys/stk/core/stkengine/__init__.py:1:1: D104 Missing docstring in public package
src/ansys/stk/core/stkobjects/__init__.py:1:1: D104 Missing docstring in public package
src/ansys/stk/core/stkobjects/aviator/__init__.py:1:1: D104 Missing docstring in public package
src/ansys/stk/core/utilities/__init__.py:1:1: D104 Missing docstring in public package

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