U
    Åmœd@  ã                   @   s–   d dl Z d dlZddlmZ G dd„ dƒZedddd	d
dddd�Zeddddd�Zeddddddddddddd d!d"d#�Zeeeƒeeƒeeƒd$�Z	dS )%é    Né   )ÚNumpyDocStringc                   @   sD   e Zd Ze dej¡Zddd„Zdd„ Ze	dd„ ƒZ
e	d	d
„ ƒZdS )ÚDocstringComponentsz\n((\n|.)+)\n\s*Tc                 C   s\   |rJi }|  ¡ D ]6\}}t | j|¡}|dkr8|||< q| d¡||< qn| ¡ }|| _dS )z@Read entries from a dict, optionally stripping outer whitespace.Nr   )ÚitemsÚreÚmatchÚregexpÚgroupÚcopyÚentries)ÚselfÚ	comp_dictÚstrip_whitespacer   ÚkeyÚvalÚm© r   úL/home/sam/Atlas/atlas_env/lib/python3.8/site-packages/seaborn/_docstrings.pyÚ__init__
   s    
zDocstringComponents.__init__c              
   C   sL   || j kr| j | S z|  |¡W S  tk
rF } z|‚W 5 d}~X Y nX dS )z7Provide dot access to entries for clean raw docstrings.N)r   Ú__getattribute__ÚAttributeError)r   ÚattrÚerrr   r   r   Ú__getattr__   s    

zDocstringComponents.__getattr__c                 K   s   | |dd�S )z$Add multiple sub-sets of components.F)r   r   )ÚclsÚkwargsr   r   r   Úfrom_nested_components+   s    z*DocstringComponents.from_nested_componentsc                 C   sX   t t |¡ƒd }i }|D ]4}|j}|j}d |j¡}|› d|› d|› �||< q| |ƒS )zAUse the numpydoc parser to extract components from existing func.Z
Parametersz
    z : )r   ÚpydocÚgetdocÚnameÚtypeÚjoinÚdesc)r   ÚfuncÚparamsr   Úpr   r    r"   r   r   r   Úfrom_function_params0   s    z(DocstringComponents.from_function_paramsN)T)Ú__name__Ú
__module__Ú__qualname__r   ÚcompileÚ	MULTILINEr   r   r   Úclassmethodr   r&   r   r   r   r   r      s   

r   a   
data : :class:`pandas.DataFrame`, :class:`numpy.ndarray`, mapping, or sequence
    Input data structure. Either a long-form collection of vectors that can be
    assigned to named variables or a wide-form dataset that will be internally
    reshaped.
    zb
x, y : vectors or keys in ``data``
    Variables that specify positions on the x and y axes.
    zs
hue : vector or key in ``data``
    Semantic variable that is mapped to determine the color of plot elements.
    a2  
palette : string, list, dict, or :class:`matplotlib.colors.Colormap`
    Method for choosing the colors to use when mapping the ``hue`` semantic.
    String values are passed to :func:`color_palette`. List or dict values
    imply categorical mapping, while a colormap object implies numeric mapping.
    zˆ
hue_order : vector of strings
    Specify the order of processing and plotting for categorical levels of the
    ``hue`` semantic.
    zó
hue_norm : tuple or :class:`matplotlib.colors.Normalize`
    Either a pair of values that set the normalization range in data units
    or an object that will map from data units into a [0, 1] interval. Usage
    implies numeric mapping.
    zÇ
color : :mod:`matplotlib color <matplotlib.colors>`
    Single color specification for when hue mapping is not used. Otherwise, the
    plot will try to hook into the matplotlib property cycle.
    zŠ
ax : :class:`matplotlib.axes.Axes`
    Pre-existing axes for the plot. Otherwise, call :func:`matplotlib.pyplot.gca`
    internally.
    )ÚdataZxyÚhueÚpaletteZ	hue_orderZhue_normÚcolorÚaxzP
:class:`matplotlib.axes.Axes`
    The matplotlib axes containing the plot.
    z²
:class:`FacetGrid`
    An object managing one or more subplots that correspond to conditional data
    subsets with convenient methods for batch-setting of axes attributes.
    z§
:class:`JointGrid`
    An object managing multiple subplots that correspond to joint and marginal axes
    for plotting a bivariate relationship or distribution.
    z­
:class:`PairGrid`
    An object managing multiple subplots that correspond to joint and marginal axes
    for pairwise combinations of multiple variables in a dataset.
    )r1   Z	facetgridÚ	jointgridÚpairgridz+
scatterplot : Plot data using points.
    z'
lineplot : Plot data using lines.
    zF
displot : Figure-level interface to distribution plot functions.
    z\
histplot : Plot a histogram of binned counts with optional normalization or smoothing.
    z[
kdeplot : Plot univariate or bivariate distributions using kernel density estimation.
    zB
ecdfplot : Plot empirical cumulative distribution functions.
    zP
rugplot : Plot a tick at each observation value along the x and/or y axes.
    z9
stripplot : Plot a categorical scatter with jitter.
    zI
swarmplot : Plot a categorical scatter with non-overlapping points.
    zL
violinplot : Draw an enhanced boxplot using kernel density estimation.
    zG
pointplot : Plot point estimates and CIs using markers and lines.
    zO
jointplot : Draw a bivariate plot with univariate marginal distributions.
    zW
jointplot : Draw multiple bivariate plots with univariate marginal distributions.
    zR
JointGrid : Set up a figure with joint and marginal views on bivariate data.
    zU
PairGrid : Set up a figure with joint and marginal views on multiple variables.
    )ZscatterplotZlineplotZdisplotZhistplotZkdeplotZecdfplotZrugplotZ	stripplotZ	swarmplotZ
violinplotZ	pointplotZ	jointplotZpairplotr2   r3   )r$   ZreturnsZseealso)
r   r   Zexternal.docscraper   r   ÚdictZ_core_paramsZ_core_returnsZ_seealso_blurbsZ
_core_docsr   r   r   r   Ú<module>   sR   ?Û-ñÍ9ý