RunasSudo/scipy-yli
1
Fork 0
Code Issues 1 Pull Requests Releases Activity

Update global.rst documentation

Browse Source
This commit is contained in:
RunasSudo 2022-10-19 08:54:22 +11:00
parent 66d7e70806
commit 05e5189fc5
Signed by: RunasSudo
GPG Key ID: 7234E476BF21C61A
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/global.rst
View File

@ -4,11 +4,16 @@ Global options
.. autodata:: yli.config .. autodata:: yli.config
.. autoattribute:: yli.config.Config.alpha .. autoattribute:: yli.config.Config.alpha
:annotation: = 0.05
.. autoattribute:: yli.config.Config.pvalue_leading_zero .. autoattribute:: yli.config.Config.pvalue_leading_zero
:annotation: = True
.. autoattribute:: yli.config.Config.pvalue_max_dps .. autoattribute:: yli.config.Config.pvalue_max_dps
:annotation: = 3
.. autoattribute:: yli.config.Config.pvalue_min_dps .. autoattribute:: yli.config.Config.pvalue_min_dps
:annotation: = 2
.. autoattribute:: yli.config.Config.repr_is_summary .. autoattribute:: yli.config.Config.repr_is_summary
:annotation: = True

2
yli/config.py
View File

@ -18,7 +18,7 @@ class Config:
"""Global configuration for the library""" """Global configuration for the library"""
def __init__(self): def __init__(self):
# NOTE: If add any attributes here, must also change docs/global.rst # NOTE: If change any attributes here, must also change docs/global.rst
#: Display at least this many decimal places for *p* values (*int*) #: Display at least this many decimal places for *p* values (*int*)
self.pvalue_min_dps = 2 self.pvalue_min_dps = 2