U
    Kvf                     @   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stt| tstd S )Nxzx : intyz	y : floatw)	r   goodr   strAssertionErrorpytestraises
ValueError
isinstanceds r   J/tmp/pip-unpacked-wheel-2v6byqio/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std	t|kstdt|kstd
t|kst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"   *