Skip to content

Commit 7009224

Browse files
committed
docs: fix Sphinx docstring formatting in get_supported_lba_formats()
Fix 'Unexpected indentation' error in docstring by simplifying the :return: field description. Changed from multi-line list example to single-line description of dict keys. This resolves the ReadTheDocs build failure.
1 parent 0231041 commit 7009224

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

avocado/utils/nvme.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -310,16 +310,15 @@ def attach_ns(ns_id, controller_name, cont_id):
310310
def get_supported_lba_formats(controller_name):
311311
"""
312312
Query and return supported LBA formats for the NVMe controller.
313-
313+
314314
This function attempts to retrieve the LBA Format (LBAF) array from an
315315
existing namespace on the controller. The LBAF array is controller-wide,
316316
meaning all namespaces on the same controller share the same set of
317317
supported formats, though each namespace can select a different format.
318-
318+
319319
:param controller_name: Name of the controller (e.g., 'nvme0')
320-
:return: List of dicts containing format details:
321-
[{'index': 0, 'block_size': 512, 'metadata_size': 0,
322-
'relative_performance': 0, 'valid': True}, ...]
320+
:return: List of dicts containing format details, each with keys:
321+
'index', 'block_size', 'metadata_size', 'relative_performance', 'valid'
323322
:rtype: list
324323
:raises: NvmeException if unable to query formats
325324
"""

0 commit comments

Comments
 (0)