Skip to content

Missing docstring in class, method and function #72

@jorgepiloto

Description

@jorgepiloto

🐞 Problem
Objects like classes and methods also require to be documented with a docstring.

src/ansys/stk/core/internal/coclassutil.py:245:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/coclassutil.py:271:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:135:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:206:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:250:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:257:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:260:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:263:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:286:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:341:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:489:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:537:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:544:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/comutil.py:548:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:46:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:82:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:171:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:745:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:1058:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:1232:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:1294:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:1441:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:1539:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:1637:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/eventutil.py:1735:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:442:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:459:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:476:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:493:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:510:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:527:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:544:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:561:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:578:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:595:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:616:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:633:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:650:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:667:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:686:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:708:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:730:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:749:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:789:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:808:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:830:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:849:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:869:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:887:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:904:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:921:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:938:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/marshall.py:955:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/timerutil.py:17:11: D101 Missing docstring in public class
src/ansys/stk/core/internal/timerutil.py:63:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/timerutil.py:86:15: D101 Missing docstring in public class
src/ansys/stk/core/internal/timerutil.py:90:11: D101 Missing docstring in public class
src/ansys/stk/core/internal/timerutil.py:128:11: D101 Missing docstring in public class
src/ansys/stk/core/internal/timerutil.py:172:11: D101 Missing docstring in public class
src/ansys/stk/core/stkdesktop.py:36:7: D101 Missing docstring in public class
src/ansys/stk/core/stkengine/__init__.py:38:7: D101 Missing docstring in public class
src/ansys/stk/core/stkengine/tkcontrols.py:28:7: D101 Missing docstring in public class
src/ansys/stk/core/internal/coclassutil.py:258:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/coclassutil.py:263:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/coclassutil.py:268:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/coclassutil.py:279:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/comutil.py:144:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/comutil.py:515:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/comutil.py:558:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/comutil.py:566:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/comutil.py:576:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:453:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:456:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:470:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:473:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:487:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:490:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:504:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:507:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:521:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:524:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:538:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:541:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:555:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:558:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:572:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:575:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:589:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:592:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:608:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:611:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:627:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:630:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:644:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:647:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:661:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:664:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:679:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:682:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:702:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:705:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:724:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:727:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:743:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:746:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:780:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:786:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:798:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:801:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:824:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:827:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:839:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:842:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:863:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:866:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:881:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:884:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:898:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:901:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:915:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:918:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:932:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:935:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:949:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:952:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:966:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/marshall.py:969:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/timerutil.py:24:13: D102 Missing docstring in public method
src/ansys/stk/core/internal/timerutil.py:73:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/timerutil.py:101:13: D102 Missing docstring in public method
src/ansys/stk/core/internal/timerutil.py:138:13: D102 Missing docstring in public method
src/ansys/stk/core/internal/timerutil.py:181:13: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:76:9: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:78:9: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:80:9: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:82:9: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:84:9: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:86:9: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:89:13: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:91:13: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:93:13: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:95:13: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:97:13: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:99:13: D102 Missing docstring in public method
src/ansys/stk/core/stkengine/tkcontrols.py:101:13: D102 Missing docstring in public method
src/ansys/stk/core/stkobjects/__init__.py:14158:9: D102 Missing docstring in public method
src/ansys/stk/core/stkx.py:1867:9: D102 Missing docstring in public method
src/ansys/stk/core/stkx.py:2281:9: D102 Missing docstring in public method
src/ansys/stk/core/stkx.py:2746:9: D102 Missing docstring in public method
src/ansys/stk/core/internal/coclassutil.py:292:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/coclassutil.py:429:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/comutil.py:393:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/dataanalysisutil.py:49:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/dataanalysisutil.py:68:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:17:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:29:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:44:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:74:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:102:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:181:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:194:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:246:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:252:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:274:5: D103 Missing docstring in public function
src/ansys/stk/core/internal/marshall.py:420:5: D103 Missing docstring in public function

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