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

Minor improvements to the docs #274

Merged
merged 7 commits into from
Oct 27, 2021
Merged

Minor improvements to the docs #274

merged 7 commits into from
Oct 27, 2021

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Oct 27, 2021

Fix reference to DatasetAccessorPrismLayer on prism_layer docstring. Replace
Equivalent Layer for Equivalent Sources on API Index and on links to their
methods in docstrings. Fix links to datasets.fetch_... functions in synthetic
surveys docstrings and shorten them. Remove additional backticks on :func:
directive for numpy.meshgrid in prism_layer.

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.

@santisoler santisoler added the documentation Improvements or additions to documentation label Oct 27, 2021
@santisoler santisoler merged commit 9d9d47e into master Oct 27, 2021
@santisoler santisoler deleted the docs-fixes branch October 27, 2021 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant