uskudnik / amazon-glacier-cmd-interface

Command line interface for Amazon Glacier
MIT License
374 stars 100 forks source link

Please write documentation #29

Closed offlinehacker closed 12 years ago

offlinehacker commented 12 years ago

I think all relevant functions should be documented. I'm not talking about cli functions, but all utility functions. We use sphinx format, which is basically following:

    """
    Checks if vault name is correct

    :param name: Vault name
    :type name: str

    :returns: True if it's correct, false otherwise
    :rtype: boolean
    """

Thanks!

offlinehacker commented 12 years ago

This one can be closed. I think docs are good enough :)