p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve docstrings for Approx classes.

This commit is contained in:
Kale Kundert 2018-07-30 23:26:57 -07:00
parent 7d8688d54b
commit ad305e71d7
No known key found for this signature in database
GPG Key ID: C6238221D17CAFAE
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/_pytest/python_api.py
View File

@ -78,7 +78,7 @@ class ApproxBase(object):
class ApproxNumpy(ApproxBase): class ApproxNumpy(ApproxBase):
""" """
Perform approximate comparisons for numpy arrays. Perform approximate comparisons where the expected value is numpy array.
""" """
def __repr__(self): def __repr__(self):
@ -132,8 +132,8 @@ class ApproxNumpy(ApproxBase):
class ApproxMapping(ApproxBase): class ApproxMapping(ApproxBase):
""" """
Perform approximate comparisons for mappings where the values are numbers Perform approximate comparisons where the expected value is a mapping with
(the keys can be anything). numeric values (the keys can be anything).
""" """
def __repr__(self): def __repr__(self):
@ -154,7 +154,8 @@ class ApproxMapping(ApproxBase):
class ApproxSequence(ApproxBase): class ApproxSequence(ApproxBase):
""" """
Perform approximate comparisons for sequences of numbers. Perform approximate comparisons where the expected value is a sequence of
numbers.
""" """
def __repr__(self): def __repr__(self):
@ -176,7 +177,7 @@ class ApproxSequence(ApproxBase):
class ApproxScalar(ApproxBase): class ApproxScalar(ApproxBase):
""" """
Perform approximate comparisons for single numbers only. Perform approximate comparisons where the expected value is a single number.
""" """
DEFAULT_ABSOLUTE_TOLERANCE = 1e-12 DEFAULT_ABSOLUTE_TOLERANCE = 1e-12
@ -290,6 +291,9 @@ class ApproxScalar(ApproxBase):
class ApproxDecimal(ApproxScalar): class ApproxDecimal(ApproxScalar):
"""
Perform approximate comparisons where the expected value is a decimal.
"""
from decimal import Decimal from decimal import Decimal
DEFAULT_ABSOLUTE_TOLERANCE = Decimal("1e-12") DEFAULT_ABSOLUTE_TOLERANCE = Decimal("1e-12")