U
    Ãmœd´  ã                   @   s€   d dl Z d dlmZmZmZ dZdZdZdZde Z	dd	„ Z
d
d„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ Zdd„ ZdS )é    N)Ú	DocstringÚremove_parametersÚ	Parametera  
This is the summary.

This is the extended summary.

Parameters
----------
x : int
    The first parameter.
y : float
    The second parameter.
z : {int, float, None}
    The final parameter.

Returns
-------
float
    Some floating point value.

See Also
--------
statsmodels.api
    The main API location.

Notes
-----
This is where the notes go.

.. index: default
   :refguide: something, else, and more

References
----------
.. [*] Reference 1 here

Examples
--------
Using the API is simple

>>> import statsmodels.api
zl
Returns
-------
float
    Some floating point value.

Unknown
-------
I don't know what this section does.
zl
Returns
-------
float
    Some floating point value.

Returns
-------
float
    Some floating point value.
zR
Returns
-------
float
    The return.

Yields
------
float
    Can't also yield.
z$
func(x)
func(x, y)
func(x, y, z=1)
c               	   C   s¦   t tƒ} |  d¡ dt| ƒks"t‚t tƒ} |  ddg¡ dt| ƒksHt‚dt| ƒksXt‚t t¡� t tƒ dg¡ W 5 Q R X ttdƒ} d| ks”t‚t| tƒs¢t‚d S )NÚxzx : intÚyz	y : floatÚw)	r   Úgoodr   ÚstrÚAssertionErrorÚpytestÚraisesÚ
ValueErrorÚ
isinstance©Úds© r   ú_/home/sam/Atlas/atlas_env/lib/python3.8/site-packages/statsmodels/tools/tests/test_docstring.pyÚtest_remove_parameterY   s    

r   c               	   C   sæ   t dddgƒ} ttƒ}| d| ¡ dt|ƒks2t‚dt|ƒksBt‚t dddgƒ}ttƒ}| d | |g¡ dt|ƒksxt‚dt|ƒksˆt‚d	t|ƒks˜t‚dt|ƒks¨t‚d
t|ƒks¸t‚ttƒ}t t¡� | d| ¡ W 5 Q R X d S )Nr   ÚndarrayúAn array input.r   zw : ndarrayÚqZ	DataFramezA pandas dataframe.zq : DataFramez---
w : ndarrayÚunknown)	r   r   r   Úinsert_parametersr	   r
   r   r   r   )Únewr   Úotherr   r   r   Útest_insert_parametersk   s     r   c               	   C   s.   t tƒ} t t¡� dg| jd< W 5 Q R X d S )Nr   ÚUnknown)r   r   r   r   r   Z_dsr   r   r   r   Útest_set_unknown€   s    r   c               	   C   sr   t tƒ} |  ddg¡ dt| ƒks&t‚t tƒ} |  dd¡ dt| ƒksJt‚t t¡� |  ddg¡ W 5 Q R X d S )NÚsummaryúThe is the new summary.r   )r   r   Úreplace_blockr	   r
   r   r   r   r   r   r   r   Útest_replace_block†   s    r!   c                	   C   s"   t  t¡� ttƒ W 5 Q R X d S ©N)r   r   r   r   Úrepeatr   r   r   r   Útest_repeat“   s    r$   c                	   C   s"   t  t¡� ttƒ W 5 Q R X d S r"   )r   r   r   r   Úbadr   r   r   r   Útest_bad˜   s    r&   c                  C   sN   t d ƒ} |  ddg¡ |  d¡ tdddgƒ}|  d|¡ t| ƒdksJt‚d S )	Nr   r   r   r   r   r   r   ÚNone)r   r    r   r   r   r	   r
   )r   r   r   r   r   Útest_empty_ds�   s    
r(   c                	   C   s"   t  t¡� ttƒ W 5 Q R X d S r"   )r   r   r   r   Ú
bad_yieldsr   r   r   r   Útest_yield_return¨   s    r*   c                   C   s   t tƒ d S r"   )r   Úwith_sigr   r   r   r   Útest_multiple_sig­   s    r,   )r   Zstatsmodels.tools.docstringr   r   r   r   r%   r#   r)   r+   r   r   r   r!   r$   r&   r(   r*   r,   r   r   r   r   Ú<module>   s"   *ü