hyperpy/pyvarint
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add param defs to the doc strings

Browse Source 
[ci skip]
This commit is contained in:
Luke Murphy 2020-07-10 12:36:19 +02:00
parent 52e2ea65f9
commit f53d9c23ca
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
pyvarint/varint.py
View File

@ -4,7 +4,10 @@ from io import BytesIO
def encode(number: int) -> bytes:
"""Encode to varint"""
"""Encode to varint
:param number: the integer to encode
"""
buf = b""
while True:
@ -20,7 +23,10 @@ def encode(number: int) -> bytes:
def decode(buf: bytes) -> int:
"""Decode to bytes"""
"""Decode to bytes
:param buf: the buffer to decode to an integer
"""
stream = BytesIO(buf)
shift = 0
@ -43,7 +49,10 @@ def decode(buf: bytes) -> int:
def encoding_length(n: int) -> int:
"""The number of bytes this number will be encoded as."""
"""The number of bytes this number will be encoded as.
:param n: the number for which the encoding length will be calculated
"""
N1 = pow(2, 7)
N2 = pow(2, 14)
N3 = pow(2, 21)