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 blackdoc to format Python codes in docstrings #641

Merged
merged 2 commits into from
Oct 4, 2020

Conversation

seisman
Copy link
Member

@seisman seisman commented Oct 4, 2020

Description of proposed changes

This PR adds blackdoc to format doctests and also wrap doctests to 79 characters, as proposed in #497 and #384.

There are two commits in this PR. It's easier to review each commit separately.

  • 3d86357: Add blackdoc support
  • a92fa5b: Run blackdoc to format docstrings

Address #497.

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.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

@seisman seisman added the maintenance Boring but important stuff for the core devs label Oct 4, 2020
@seisman seisman added this to In progress in Release v0.2.x via automation Oct 4, 2020
@seisman seisman added this to the 0.2.1 milestone Oct 4, 2020
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Looks nice! Still need to seek out a tool to wrap the docstrings themselves to 79 characters, but one step at a time 😄

@seisman seisman merged commit 1bf0a30 into master Oct 4, 2020
Release v0.2.x automation moved this from In progress to Done Oct 4, 2020
@seisman seisman deleted the blackdoc-docstrings branch October 4, 2020 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants