Skip to content

Clean up docstrings to PEP257 specs and enable CI linting with pep257 #1474

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

Closed
22 tasks
agjohnson opened this issue Jul 22, 2015 · 4 comments
Closed
22 tasks
Labels
Feature New feature Good First Issue Good for new contributors Sprintable Small enough to sprint on
Milestone

Comments

@agjohnson
Copy link
Contributor

Once #1471 addresses initial linting errors, we will continue linting clean up by targetting errors produced by pep257 linting. Similar to #1471, address docstring cleanup efforts in small chunks, which will be easier to merge into other work and will not create broad changes that are difficult to merge. This will encourage the clean up effort to be quick, and will not block other work.

Work addressing clean up efforts can reference this ticket.

Applications that may cause linting errors due to pep257 failures:

  • api
  • betterversion
  • bookmarks
  • builds
  • comments
  • core
  • djangome
  • doc_builder
  • donate
  • gold
  • oauth
  • privacy
  • profiles
  • projects
  • redirects
  • restapi
  • rtd_tests
  • search
  • settings
  • tastyapi
  • templates
  • vcs_support

refs #1424

@agjohnson agjohnson added Good First Issue Good for new contributors Feature New feature Sprintable Small enough to sprint on labels Jul 22, 2015
@agjohnson agjohnson added this to the Cleanup milestone Jul 22, 2015
@agjohnson agjohnson added the Status: blocked Issue is blocked on another issue label Jul 22, 2015
@gregmuellegger gregmuellegger removed the Status: blocked Issue is blocked on another issue label Aug 20, 2015
@gregmuellegger
Copy link
Contributor

It's no longer blocked and open for everyone who wants to tackle this.

@rixx
Copy link
Contributor

rixx commented Mar 9, 2017

@agjohnson, @gregmuellegger do you have an overview over which parts of this are still open (and maybe update the issue check list)? I see that core and api have been done in #2245 already.

@alexwlchan
Copy link
Contributor

If it weren’t obvious from the flurry of PRs, I’m planning to work on this.

I’ll try not to have too many PRs open at once, so I don’t spam the repo. :-)

@agjohnson
Copy link
Contributor Author

@alexwlchan this is great, thanks for the help cleaning up! i'll keep up with the cleanup efforts so that things don't go stale. So far, things are looking good -- small PRs is a good way to not clobber some of the other work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature Good First Issue Good for new contributors Sprintable Small enough to sprint on
Projects
None yet
Development

No branches or pull requests

4 participants