fmap.py: fix docstring style issues
`cros lint` flags a bunch of issues with these docstrings.
Clean up the style to pass all the checks.
BUG=chromium:982465
TEST=`cros lint` on these no longer complains about docstrings
Change-Id: I7caf0275ce1441bb4031f7d8e9e0ac96bfdf9b05
Reviewed-on: https://chromium-review.googlesource.com/1693885
Tested-by: Mike Frysinger <vapier@chromium.org>
Commit-Ready: Mike Frysinger <vapier@chromium.org>
Legacy-Commit-Queue: Commit Bot <commit-bot@chromium.org>
Reviewed-by: Duncan Laurie <dlaurie@google.com>
diff --git a/fmap.py b/fmap.py
index 9b635a1..936b1ce 100755
--- a/fmap.py
+++ b/fmap.py
@@ -96,7 +96,7 @@
def _fmap_decode_header(blob, offset):
- """ (internal) Decodes a FMAP header from blob by offset"""
+ """(internal) Decodes a FMAP header from blob by offset"""
header = {}
for (name, value) in zip(FMAP_HEADER_NAMES,
struct.unpack_from(FMAP_HEADER_FORMAT,
@@ -117,7 +117,7 @@
def _fmap_decode_area(blob, offset):
- """ (internal) Decodes a FMAP area record from blob by offset """
+ """(internal) Decodes a FMAP area record from blob by offset"""
area = {}
for (name, value) in zip(FMAP_AREA_NAMES,
struct.unpack_from(FMAP_AREA_FORMAT, blob, offset)):
@@ -130,7 +130,7 @@
def _fmap_decode_area_flags(area_flags):
- """ (internal) Decodes a FMAP flags property """
+ """(internal) Decodes a FMAP flags property"""
return tuple([name for name in FMAP_FLAGS if area_flags & FMAP_FLAGS[name]])
@@ -180,18 +180,18 @@
except struct.error as e:
# Search for next FMAP candidate.
logging.debug('Continue searching FMAP due to exception %r', e)
- pass
- align /= 2
+ align //= 2
raise struct.error('No valid FMAP signatures.')
def fmap_decode(blob, offset=None, fmap_name=None):
- """ Decodes a blob to FMAP dictionary object.
+ """Decodes a blob to FMAP dictionary object.
- Arguments:
+ Args:
blob: a binary data containing FMAP structure.
offset: starting offset of FMAP. When omitted, fmap_decode will search in
the blob.
+ fmap_name: A string to specify target FMAP name.
"""
fmap = {}
@@ -211,21 +211,21 @@
def _fmap_encode_header(obj):
- """ (internal) Encodes a FMAP header """
+ """(internal) Encodes a FMAP header"""
values = [obj[name] for name in FMAP_HEADER_NAMES]
return struct.pack(FMAP_HEADER_FORMAT, *values)
def _fmap_encode_area(obj):
- """ (internal) Encodes a FMAP area entry """
+ """(internal) Encodes a FMAP area entry"""
values = [obj[name] for name in FMAP_AREA_NAMES]
return struct.pack(FMAP_AREA_FORMAT, *values)
def fmap_encode(obj):
- """ Encodes a FMAP dictionary object to blob.
+ """Encodes a FMAP dictionary object to blob.
- Arguments
+ Args:
obj: a FMAP dictionary object.
"""
# fix up values
