From 93ca4c98fe1d0910174537322c4c7cb8b6e75e70 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Sat, 16 Nov 2013 21:09:46 -0800 Subject: [PATCH] Document the 'B' type and the difference between 'b' & 'B'. Addresses part of issue https://github.com/vitaut/format/issues/5 --- doc/index.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/index.rst b/doc/index.rst index 753893dc..6788a25f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -228,7 +228,13 @@ The available integer presentation types are: +---------+----------------------------------------------------------+ | Type | Meaning | +=========+==========================================================+ - | ``'b'`` | Binary format. Outputs the number in base 2. | + | ``'b'`` | Binary format. Outputs the number in base 2. Using the | + | | ``'#'`` option with this type adds the prefix ``"0b"`` | + | | to the output value. | + +---------+----------------------------------------------------------+ + | ``'B'`` | Binary format. Outputs the number in base 2. Using the | + | | ``'#'`` option with this type adds the prefix ``"0B"`` | + | | to the output value. | +---------+----------------------------------------------------------+ | ``'d'`` | Decimal integer. Outputs the number in base 10. | +---------+----------------------------------------------------------+