σ
ίΘ[c           @` sz   d  Z  d d l m Z m Z m Z m Z d d d d g Z d d  Z d d  Z d d	  Z	 d d
  Z
 d d  Z d S(   uJ   
astropy.wcs-specific utilities for generating boilerplate in docstrings.
i    (   t   absolute_importt   divisiont   print_functiont   unicode_literalsu   TWO_OR_MORE_ARGSu   RETURNSu   ORIGINu   RA_DEC_ORDERc         C` s*   |  j  d  } d d | } | j |  S(   Nu   
u    (   t   splitt   join(   t   contentt   indentt   lines(    (    s3   lib/python2.7/site-packages/astropy/wcs/_docutil.pyt   _fix   s    c         C` s   t  d j |   |  S(   Nuη  args : flexible
    There are two accepted forms for the positional arguments:

        - 2 arguments: An *N* x *{0}* array of coordinates, and an
          *origin*.

        - more than 2 arguments: An array for each axis, followed by
          an *origin*.  These arrays must be broadcastable to one
          another.

    Here, *origin* is the coordinate in the upper left corner of the
    image.  In FITS and Fortran standards, this is 1.  In Numpy and C
    standards this is 0.
(   R	   t   format(   t   naxisR   (    (    s3   lib/python2.7/site-packages/astropy/wcs/_docutil.pyt   TWO_OR_MORE_ARGS   s    c         C` s   t  d j |   |  S(   Nu   result : array
    Returns the {0}.  If the input was a single array and
    origin, a single array is returned, otherwise a tuple of arrays is
    returned.(   R	   R
   (   t   out_typeR   (    (    s3   lib/python2.7/site-packages/astropy/wcs/_docutil.pyt   RETURNS$   s    c         C` s   t  d |   S(   Nu¦   
origin : int
    Specifies the origin of pixel values.  The Fortran and FITS
    standards use an origin of 1.  Numpy and C use array indexing with
    origin at 0.
(   R	   (   R   (    (    s3   lib/python2.7/site-packages/astropy/wcs/_docutil.pyt   ORIGIN+   s    c         C` s   t  d |   S(   Nuό   
ra_dec_order : bool, optional
    When `True` will ensure that world coordinates are always given
    and returned in as (*ra*, *dec*) pairs, regardless of the order of
    the axes specified by the in the ``CTYPE`` keywords.  Default is
    `False`.
(   R	   (   R   (    (    s3   lib/python2.7/site-packages/astropy/wcs/_docutil.pyt   RA_DEC_ORDER5   s    N(   t   __doc__t
   __future__R    R   R   R   t   __all__R	   R   R   R   R   (    (    (    s3   lib/python2.7/site-packages/astropy/wcs/_docutil.pyt   <module>   s   "
