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

Docstring improvement and check API links #142

Merged
merged 16 commits into from
Jul 13, 2023
Merged

Docstring improvement and check API links #142

merged 16 commits into from
Jul 13, 2023

Commits on Jul 10, 2023

  1. Use sphinx-favicon to fix deprecated favicons option of `pydata-s… 

    …phinx-theme`
    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    6a58ead View commit details
    Browse the repository at this point in the history

  2. Fix link docstrings in zspy, nexus and utils.hdf5

    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    9d93743 View commit details
    Browse the repository at this point in the history

  3. Fix link docstrings in msa, mrc and blockfile

    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    ce97b7a View commit details
    Browse the repository at this point in the history

  4. Set numpydoc xref options

    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    b8388dd View commit details
    Browse the repository at this point in the history

  5. Fix docstrings type

    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    643e939 View commit details
    Browse the repository at this point in the history

  6. Enable numpydoc validation when running sphinx

    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    3178c82 View commit details
    Browse the repository at this point in the history

  7. Fix codeql warning

    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    228fbdf View commit details
    Browse the repository at this point in the history

  8. Tidy up update_registry.py

    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    eda83b9 View commit details
    Browse the repository at this point in the history

  9. Fail the docs build on warning

    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    c7dca0a View commit details
    Browse the repository at this point in the history

  10. Use nitpick_ignore_regex to ignore API interphinx links warning unt… 

    …il they are fixed in `hyperspy`
    @ericpre
    ericpre committed Jul 10, 2023
    Configuration menu
    Copy the full SHA
    24fd789 View commit details
    Browse the repository at this point in the history

Commits on Jul 11, 2023

  1. Update contributing guide: explain about broken links, warning and `D… 

    …ocs` GitHub CI failure
    @ericpre
    ericpre committed Jul 11, 2023
    Configuration menu
    Copy the full SHA
    dbaef20 View commit details
    Browse the repository at this point in the history

  2. Test for lazy not implemented

    @ericpre
    ericpre committed Jul 11, 2023
    Configuration menu
    Copy the full SHA
    e0b32ac View commit details
    Browse the repository at this point in the history

  3. Simplify logic import netcdf and use scipy netdcf reader as fallback

    @ericpre
    ericpre committed Jul 11, 2023
    Configuration menu
    Copy the full SHA
    66f5a17 View commit details
    Browse the repository at this point in the history

  4. Increase test coverage

    @ericpre
    ericpre committed Jul 11, 2023
    Configuration menu
    Copy the full SHA
    9407655 View commit details
    Browse the repository at this point in the history

  5. Add changelog entry

    @ericpre
    ericpre committed Jul 11, 2023
    Configuration menu
    Copy the full SHA
    7d5afe3 View commit details
    Browse the repository at this point in the history

Commits on Jul 13, 2023

  1. Update CONTRIBUTING.rst

    @jlaehne
    jlaehne authored Jul 13, 2023
    Configuration menu
    Copy the full SHA
    8f193f0 View commit details
    Browse the repository at this point in the history