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.

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

DOC: Fix API strings for documentation #48

Closed
KCollins opened this issue Sep 27, 2024 · 0 comments
Closed

DOC: Fix API strings for documentation #48

KCollins opened this issue Sep 27, 2024 · 0 comments
Labels
good first issue Good for newcomers
Milestone

Comments

@KCollins
Copy link
Owner

KCollins commented Sep 27, 2024

Related to #46 , #47

Example from conjugate_map:

def calc_mlat_rings(mlats, ut=dt.datetime.now(tz=dt.timezone.utc),
                    is_verbose=False, is_saved=False):

    """Calculate the geographic latitudes and longitudes of a circle of points
    for a list of magnetic latitudes.

    Parameters
    ----------
    mlats       : np.array
            List of magnetic latitudes
    ut          : dt.datetime
            Datetime used in AACGMv2 conversion;
            by default, ut=dt.datetime.now(tz=dt.timezone.utc)
    is_verbose  : boolean
            If set to True/1, prints debugging text.
    is_saved    : boolean
            If is_saved == True, saves .gpx versions.
                        to local output directory

    Returns
    -------
    mlats_dct: dict
        Dictionary with geographic latitude and longitude
        points for each of the specified magnetic latitudes.

    Example Use
    ------------
    Saves .gpx magnetic graticules for 1 January 2020 every 5
    degrees latitude::

        rings = calc_mlat_rings(list(range(-90, 90, 5)), ut =
                        dt.datetime(2020, 1, 1), is_saved = True)

    """
    """
@KCollins KCollins added this to the v0.1.4 milestone Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
@KCollins KCollins added the good first issue Good for newcomers label Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
KCollins added a commit that referenced this issue Sep 27, 2024
KCollins added a commit that referenced this issue Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant