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

Add EquivalentSources to API index #270

Merged
merged 1 commit into from Oct 22, 2021
Merged

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Oct 22, 2021

Replace EQLHarmonic and EQLHarmonicSpherical for EquivalentSources and
EquivalentSourcesSph in doc/api/index.rst.

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

Replace EQLHarmonic and EQLHarmonicSpherical for EquivalentSources and
EquivalentSourcesSph in doc/api/index.rst
@santisoler santisoler added bug Report a problem that needs to be fixed documentation Improvements or additions to documentation labels Oct 22, 2021
@santisoler santisoler merged commit 76154a9 into master Oct 22, 2021
@santisoler santisoler deleted the equivalent-sources-docs branch October 22, 2021 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Report a problem that needs to be fixed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant