circle(Surface, color, pos, radius, width=0) -> Rect
このように 関数シグネチャ -> 返すもの
形式でdocstringを提供するのは、pythonのC実装関数(主に組み込み関数等)で関数のヘルプドキュメントを提供するときの書き方です。規約は見つけられませんでした(知ってる方いたら教えてください)ので、おそらく慣習ということになります。
例えばstrのdocstringを見ると以下のように表示されます。
python
1>>> help(str)
2Help on class str in module builtins:
3
4class str(object)
5 | str(object='') -> str
6 | str(bytes_or_buffer[, encoding[, errors]]) -> str
これはPython本体での例ですが、pygameなどのC実装された関数を提供するライブラリでは、この記法で表示するようにdocstringを合わせていると思います。
以下、オマケ情報です。
Pythonの関数、メソッドは常にこのようにdocstringを書くのが正しいかというと、C実装ではないPure Python関数などでは書くべきではありません。
https://www.python.org/dev/peps/pep-0257/ では、 The one-line docstring should NOT be a "signature" reiterating the function/method parameters (which can be obtained by introspection)
という説明があり、書くべきでは無いとされています。
他の方が書かれているように、Pure Pythonの関数宣言に型情報を書けるようになったのが、型アノテーション、型ヒント、type hintsと呼ばれるものです。これはpygameのdocstringとは別ですが、これによって、Pure Pythonの世界で ->
の記法を文法化して、コードの一部として書けるようになりました。(一次情報が見つからなかったので推測ですが、CPython関数で ->
のように慣習(?)で書かれていた記法の影響を受けているんじゃないかなあ。)
初めは、文法だけがPython3で導入され、Python 3.5ではtype hintsが正式に導入されました。以下のように書けます。
python
1def get_something(age:int) -> str:
2 ...
type hints は規約、文法の規定があります。
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。