mieki256's diary

BG画像をセル単位に分割・共通セルを見つけ出すPythonスクリプトを作成するためにPython勉強中。

_Python ドキュメンテーション文字列(docstring) てのがよくわからない。1行で書く場合と、複数行で書く場合があるらしいのだけど。

- この docstring はピリオドで終わる文です．この文字列では，関数や メソッドの ("あれを行う", "それを返す" といった) 命令としての効果 を既定し，詳細記述は行いません; "... であるパス名を返す" のようには 書かないでください．

http://www.python.jp/doc/contrib/peps/pep-0257.txt より

てのがわからない。「〜のようには書かないでください」の具体的事例が想像できないわけで。どこかにサンプル・参考になりそうなソースはないのかな。