Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

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

Merged
merged 2 commits into from
Jul 21, 2020
Merged

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

merged 2 commits into from
Jul 21, 2020

Conversation

leouieda
Copy link
Member

For some reason we weren't formatting this file. Ran black on it 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.

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.
  • If adding new example, please build the docs with make -C doc gallery and push the changes made on doc/gallery. Continuous Integration services build and deploy the docs, but they won't run the examples.
  • 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.

Reminders for Maintainers:

  • Maintainers must run all tests locally before the PR is merged. CIs run only minimal tests and styling checks.

For some reason we weren't formatting this file. Ran black on it 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.
@leouieda leouieda added the maintenance Repository maintenance task (no user-facing change) label Jul 17, 2020
@leouieda leouieda requested a review from santisoler July 17, 2020 13:19
Copy link
Member

@santisoler santisoler left a comment

Choose a reason for hiding this comment

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

Great!
I think this is issue exists on every Fatiando package, and probably on the package template repository.
If that's the case, we should update them all.

santisoler added a commit to fatiando/harmonica that referenced this pull request Jul 17, 2020
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 added a commit to fatiando/boule that referenced this pull request Jul 17, 2020
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
leouieda pushed a commit to fatiando/boule that referenced this pull request Jul 20, 2020
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
@leouieda leouieda merged commit 683224e into master Jul 21, 2020
@leouieda leouieda deleted the format-conf branch July 21, 2020 15:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
maintenance Repository maintenance task (no user-facing change)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants