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

Format the doc/conf.py file with Black #41

Merged
merged 1 commit into from
Jul 20, 2020
Merged

Format the doc/conf.py file with Black #41

merged 1 commit into from
Jul 20, 2020

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Jul 17, 2020

Ran black on doc/conf.py and added it to the black and flake8 runs
in the main Makefile.

Inspired on fatiando/rockhound#87

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.

Ran black on `doc/conf.py` and added it to the `black` and `flake8` runs
in the main Makefile. Removed the setting of `sys.path` since we're
installing the packaged in edit mode so it should be importable without
that hack.

Inspired on fatiando/rockhound#87
@santisoler santisoler requested a review from leouieda July 17, 2020 18:04
Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for porting these, @santisoler

@leouieda leouieda merged commit c5e88b3 into master Jul 20, 2020
@leouieda leouieda deleted the format-conf branch July 20, 2020 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants