読者です 読者をやめる 読者になる 読者になる

ボールを蹴りたいシステムエンジニア

ボール蹴りが大好きなシステムエンジニア、ボールを蹴る時間確保の為に時間がある時には勉強する。

【Python】 D100 Missing docstring in public module

python入門の勉強して最初に遭遇した警告。

D100 Missing docstring in public module

調べた所、公開モジュールにdocstringで説明がないという警告らしい。
flake8でのコーディングルール規約?

ちなみにdocstringとはモジュールやクラス、関数などにつける説明文の事らいい。
javaで言うjavaDocみたいな?

って事でこんな感じで起債したら警告でなくなった。

# -*- coding: utf-8 -*-
"""
このモジュールの説明
"""

flake8で、Dで始まる警告は全てdocstringに関するルールらしい。
警告対象外としても良いかも。

	"ignore": ["E225", "D"],