pydu/docs/unit.rst

Unit
----

Utils for handling unit.

.. py:class:: pydu.unit.Bytes(bytes)

    Supply several methods dealing with bytes.

    .. py:method:: convert(self, unit=None, multiple=1024)

        Convert bytes with given ``unit``.
        If ``unit`` is None, convert bytes with suitable unit.
        Convert ``multiple`` is default to be 1024.

        >>> Bytes(1024).convert()
        (1, 'KB')
add doc for unit 2017-12-19 22:25:10 +00:00			`Unit`
			`----`

Add short description for utils 2018-03-10 05:12:01 +00:00			`Utils for handling unit.`

add doc for unit 2017-12-19 22:25:10 +00:00			`.. py:class:: pydu.unit.Bytes(bytes)`

			`Supply several methods dealing with bytes.`

			`.. py:method:: convert(self, unit=None, multiple=1024)`

fix typo 2017-12-21 05:05:32 +00:00			Convert bytes with given ``unit``.
			If ``unit`` is None, convert bytes with suitable unit.
add doc for unit 2017-12-19 22:25:10 +00:00			Convert ``multiple`` is default to be 1024.

			`>>> Bytes(1024).convert()`
			`(1, 'KB')`