Skip to content

Commit f849866

Browse files
author
Vasileios Karakasis
committed
Fix documentation of sanity functions accepting a filename
1 parent 7ddadba commit f849866

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

reframe/utility/sanity.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -367,10 +367,9 @@ def assert_found(patt, filename, msg=None, encoding='utf-8'):
367367
The `re.MULTILINE
368368
<https://docs.python.org/3/library/re.html#re.MULTILINE>`_ flag
369369
is set for the pattern search.
370-
371-
:arg filename: The name of the file to examine.
372-
Any :class:`OSError` raised while processing the file will be
373-
propagated as a :class:`reframe.core.exceptions.SanityError`.
370+
:arg filename: The name of the file to examine or a file descriptor as in
371+
:py:func:`open`. Any :class:`OSError` raised while processing the file
372+
will be propagated as a :class:`reframe.core.exceptions.SanityError`.
374373
:arg encoding: The name of the encoding used to decode the file.
375374
:returns: ``True`` on success.
376375
:raises reframe.core.exceptions.SanityError: if assertion fails.
@@ -612,7 +611,8 @@ def extractall(patt, filename, tag=0, conv=None, encoding='utf-8'):
612611
The `re.MULTILINE
613612
<https://docs.python.org/3/library/re.html#re.MULTILINE>`_ flag
614613
is set for the pattern search.
615-
:arg filename: The name of the file to examine.
614+
:arg filename: The name of the file to examine or a file descriptor as in
615+
:py:func:`open`.
616616
:arg encoding: The name of the encoding used to decode the file.
617617
:arg tag: The regex capturing group to be extracted.
618618
Group ``0`` refers always to the whole match.

0 commit comments

Comments
 (0)