Skip to content

[bugfix] Fix documentation of sanity functions accepting a filename #1666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 21, 2020
Merged

[bugfix] Fix documentation of sanity functions accepting a filename #1666

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f849866
Fix documentation of sanity functions accepting a filename
Dec 20, 2020
c027ead
Merge branch 'master' into docs/fix-sanity-function-docs
Dec 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions reframe/utility/sanity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,10 +367,9 @@ def assert_found(patt, filename, msg=None, encoding='utf-8'):
The `re.MULTILINE
<https://docs.python.org/3/library/re.html#re.MULTILINE>`_ flag
is set for the pattern search.

:arg filename: The name of the file to examine.
Any :class:`OSError` raised while processing the file will be
propagated as a :class:`reframe.core.exceptions.SanityError`.
:arg filename: The name of the file to examine or a file descriptor as in
:py:func:`open`. Any :class:`OSError` raised while processing the file
will be propagated as a :class:`reframe.core.exceptions.SanityError`.
:arg encoding: The name of the encoding used to decode the file.
:returns: ``True`` on success.
:raises reframe.core.exceptions.SanityError: if assertion fails.
Expand Down Expand Up @@ -612,7 +611,8 @@ def extractall(patt, filename, tag=0, conv=None, encoding='utf-8'):
The `re.MULTILINE
<https://docs.python.org/3/library/re.html#re.MULTILINE>`_ flag
is set for the pattern search.
:arg filename: The name of the file to examine.
:arg filename: The name of the file to examine or a file descriptor as in
:py:func:`open`.
:arg encoding: The name of the encoding used to decode the file.
:arg tag: The regex capturing group to be extracted.
Group ``0`` refers always to the whole match.
Expand Down