Skip to content

Commit

Permalink
Fix docstrings for sphinx
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Brennan <[email protected]>
  • Loading branch information
brenns10 committed Aug 16, 2024
1 parent 5beaa23 commit 8071d1a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
9 changes: 5 additions & 4 deletions drgn_tools/lock.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,11 @@ def scan_osq_node(prog: Program, verbosity: int = 0) -> None:
:param prog: drgn.Program
:param verbosity: specify verbosity of report as follows:
0: Show which CPUs are spinning
1: Show which CPUs are spinning and for how long
2: Show spinning CPUs, their spin duration and call stack
till the point of spin
* ``0`` Show which CPUs are spinning
* ``1`` Show which CPUs are spinning and for how long
* ``2`` Show spinning CPUs, their spin duration and call stack till the
point of spin
"""

osq_spinners: DefaultDict[int, List[int]] = defaultdict(list)
Expand Down
5 changes: 2 additions & 3 deletions drgn_tools/locking.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,8 @@ def mutex_owner(prog: Program, mutex: drgn.Object) -> drgn.Object:
:param prog: drgn program
:param mutex: ``struct mutex *``
:param : ``struct task_struct *``
:returns: ``struct task_struct *`` corresponding to owner,
or NULL if there is no owner
:returns: ``struct task_struct *`` corresponding to owner, or NULL if there
is no owner
"""

try:
Expand Down
4 changes: 2 additions & 2 deletions drgn_tools/rds.py
Original file line number Diff line number Diff line change
Expand Up @@ -1479,8 +1479,8 @@ def rds_get_mr_list_info(
Print the MR list info
:param prog_or_obj: drgn program or ``struct rds_ib_device`` Object
:prarm dev_ptr: ``struct rds_ib_device`` address as an integer.
returns: None
:param dev_ptr: ``struct rds_ib_device`` address as an integer.
:returns: None
"""

if isinstance(prog_or_obj, Program):
Expand Down

0 comments on commit 8071d1a

Please sign in to comment.