Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Turn all short aliases into long form #474

Merged
merged 25 commits into from
Jun 4, 2020
Merged

Turn all short aliases into long form #474

merged 25 commits into from
Jun 4, 2020

Commits on Jun 1, 2020

  1. Turn common aliases from short form to long form 

    To make things more readable, we'll shift our documentation to use long form arguments by default. Starting from the common aliases R, J, B, U, CPT, G and W.
    @weiji14
    weiji14 committed Jun 1, 2020
    Configuration menu
    Copy the full SHA
    c75d2d1 View commit details
    Browse the repository at this point in the history

  2. Fix fmt_docstring test

    @weiji14
    weiji14 committed Jun 1, 2020
    Configuration menu
    Copy the full SHA
    1e14b72 View commit details
    Browse the repository at this point in the history

  3. Alias U as timestamp instead of logo 

    Also added timestamp (U) alias to the plotting functions that have them.

Co-Authored-By: Dongdong Tian <[email protected]>
    @weiji14 @seisman
    weiji14 and seisman committed Jun 1, 2020
    Configuration menu
    Copy the full SHA
    144effa View commit details
    Browse the repository at this point in the history

Commits on Jun 2, 2020

  1. Remove short aliases for makecpt

    @weiji14
    weiji14 committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    2223ae2 View commit details
    Browse the repository at this point in the history

  2. Remove short aliases for surface

    @weiji14
    weiji14 committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    f5fc1a3 View commit details
    Browse the repository at this point in the history

  3. Add common alias interpolation (n) for grdtrack 

    Also standardize formatting of grdtrack docstring in line with other docs.
    @weiji14
    weiji14 committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    8906d59 View commit details
    Browse the repository at this point in the history

  4. Remove short alias for which and refactor test

    @weiji14
    weiji14 committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    db842e7 View commit details
    Browse the repository at this point in the history

  5. Remove short aliases from coast

    @seisman
    seisman committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    71fb973 View commit details
    Browse the repository at this point in the history

  6. Remove short aliases from colorbar

    @seisman
    seisman committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    f131cd5 View commit details
    Browse the repository at this point in the history

  7. Improve docstring of colorbar

    @seisman
    seisman committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    57f25ea View commit details
    Browse the repository at this point in the history

  8. Remove short aliases from grdcontour

    @seisman
    seisman committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    ce6e84f View commit details
    Browse the repository at this point in the history

  9. Remove short aliases from legend

    @seisman
    seisman committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    cb5fb41 View commit details
    Browse the repository at this point in the history

  10. Remove short aliases for logo

    @seisman
    seisman committed Jun 2, 2020
    Configuration menu
    Copy the full SHA
    ac6aad3 View commit details
    Browse the repository at this point in the history

Commits on Jun 3, 2020

  1. Aliased per_column(C), spacing(I), nearest_multiple(T) for info 

    Also updated test_info.py to use long aliases instead of short ones, though the output of `info` are still strings that use short aliases.
    @weiji14
    weiji14 committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    52b8d0c View commit details
    Browse the repository at this point in the history

  2. Remove short aliases for psconvert and improve fmt docstring

    @weiji14
    weiji14 committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    aa369dc View commit details
    Browse the repository at this point in the history

  3. Add U to docstring of grdcontour

    @seisman
    seisman committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    718e786 View commit details
    Browse the repository at this point in the history

  4. Remove short aliases for plot

    @seisman
    seisman committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    b8f7b33 View commit details
    Browse the repository at this point in the history

  5. Remove short aliases for contour

    @seisman
    seisman committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    30136d5 View commit details
    Browse the repository at this point in the history

  6. Improve docstring of text

    @weiji14
    weiji14 committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    c320756 View commit details
    Browse the repository at this point in the history

  7. Remove short alias from image 

    Also document the required imagefile parameter that was missing.
    @weiji14
    weiji14 committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    d9a3290 View commit details
    Browse the repository at this point in the history

  8. Use frame instead of B for basemap.

    @weiji14
    weiji14 committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    d87b7e4 View commit details
    Browse the repository at this point in the history

  9. Fix a typo "book"->"bool" 

    Co-authored-by: Wei Ji <[email protected]>
    @seisman @weiji14
    seisman and weiji14 committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    e3b5183 View commit details
    Browse the repository at this point in the history

  10. Alias map_scale(L), rose(Td), compass(Tm) for basemap

    @weiji14
    weiji14 committed Jun 3, 2020
    Configuration menu
    Copy the full SHA
    15b9c6b View commit details
    Browse the repository at this point in the history

Commits on Jun 4, 2020

  1. Change x, y to x/y in docstrings to make it look nicer

    @weiji14
    weiji14 committed Jun 4, 2020
    Configuration menu
    Copy the full SHA
    a1f5839 View commit details
    Browse the repository at this point in the history

  2. Fix string to str in docstrings

    @seisman
    seisman committed Jun 4, 2020
    Configuration menu
    Copy the full SHA
    8869feb View commit details
    Browse the repository at this point in the history