Skip to content

Commit 1684675

Browse files
committed
Added docs for binary package
1 parent 93cd483 commit 1684675

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

docs/Binary.rst

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
=================
2+
Binary Algorithms
3+
=================
4+
5+
A place for implementation of base conversions
6+
7+
Features
8+
--------
9+
10+
* To see all the available functions in a module, you can just type ``help()`` with the module name as argument. For example,
11+
12+
.. code:: python
13+
14+
>>> from pygorithm import binary
15+
>>> help(binary)
16+
Help on package pygorithm.binary in pygorithm:
17+
18+
NAME
19+
pygorithm.binary - Collection or binary conversions and algorithms
20+
21+
MODULE REFERENCE
22+
https://docs.python.org/3.5/library/pygorithm.binary.html
23+
24+
The following documentation is automatically generated from the Python
25+
source files. It may be incomplete, incorrect or include features that
26+
are considered implementation detail and may vary between Python
27+
implementations. When in doubt, consult the module reference at the
28+
location listed above.
29+
30+
PACKAGE CONTENTS
31+
ascii
32+
base10
33+
base16
34+
base2
35+
binary_utils
36+
37+
DATA
38+
__all__ = ['ascii', 'base2', 'base10', 'base16']
39+
40+
41+
ASCII Conversions
42+
-----------------
43+
44+
* Functions and their uses
45+
46+
.. automodule:: pygorithm.binary.ascii
47+
:members:
48+
49+
Base2 Coversions
50+
----------------
51+
52+
* Functions and their uses
53+
54+
.. automodule:: pygorithm.binary.base2
55+
:members:
56+
57+
58+
Base10 Coversions
59+
-----------------
60+
61+
* Functions and their uses
62+
63+
.. automodule:: pygorithm.binary.base10
64+
:members:
65+
66+
Base16 Coversions
67+
-----------------
68+
69+
* Functions and their uses
70+
71+
.. automodule:: pygorithm.binary.base16
72+
:members:

0 commit comments

Comments
 (0)