Skip to content
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

docs: make the nature of content clearer #153

Merged
merged 1 commit into from
Nov 14, 2023
Merged

docs: make the nature of content clearer #153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/pytest_regressions/file_regression.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ def check(
"""
Checks the contents against a previously recorded version, or generate a new file.

:param contents: content to be verified.
:param contents: content of the file to be verified as text or bytes.
:param encoding: Encoding used to write file, if any.
:param extension: Extension of file.
:param newline: See `io.open` docs.
:param binary: If the file is binary or text.
:param binary: If the provided content is binary or text.
:param obtained_filename: ..see:: FileRegressionCheck
:param check_fn: a function with signature ``(obtained_filename, expected_filename)`` that should raise
AssertionError if both files differ.
Expand Down