巨人の肩の上に登る

先人の積み重ねた発見に基づいて、なにかを発見しようとすることを指す。

Python Docstring の書き方

Python では,関数のはじめに docstring を3重クオートを用いて記述する.
いつも,引数・戻り値などの書き方を悩むのですが,良さそうなものがあったのでメモ.

Dive Into Python 3 からの引用

def approximate_size(size, a_kilobyte_is_1024_bytes=True):
    '''Convert a file size to human-readable form.

    Keyword arguments:
    size -- file size in bytes
    a_kilobyte_is_1024_bytes -- if True (default), use multiples of 1024
                                if False, use multiples of 1000

    Returns: string

    '''