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

pydocstyle for log.py #999

Merged
merged 3 commits into from
Nov 25, 2017
Merged

pydocstyle for log.py #999

merged 3 commits into from
Nov 25, 2017

Conversation

meahow
Copy link
Contributor

@meahow meahow commented Oct 14, 2017

This is for #742
I changed the format of the docstrings for cookiecutter/log.py to follow pep257 style

@@ -18,6 +20,11 @@


def configure_logger(stream_level='DEBUG', debug_file=None):
"""Configure logging for cookiecutter.

Set up logging to stdout with given level and with DEBUG level for loggin
Copy link
Member

Choose a reason for hiding this comment

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

Typo logging

"""Configure logging for cookiecutter.

Set up logging to stdout with given level and with DEBUG level for loggin
to file if debug_file given
Copy link
Member

Choose a reason for hiding this comment

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

Missing .

@hackebrot hackebrot added code style This issue/PR relates to the project code style modification documentation This issue/PR relates to or includes documentation. waiting-for-contributor Waiting for answer from original contributor. labels Oct 15, 2017
@meahow
Copy link
Contributor Author

meahow commented Oct 15, 2017

@hackebrot
Comments addressed.
Thanks for quick feedback and sorry for being so sloppy :)

@codecov-io
Copy link

codecov-io commented Oct 15, 2017

Codecov Report

Merging #999 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #999   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          18     18           
  Lines         780    781    +1     
=====================================
+ Hits          780    781    +1
Impacted Files Coverage Δ
cookiecutter/log.py 100% <100%> (ø) ⬆️
cookiecutter/extensions.py 100% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5503196...cbb9165. Read the comment docs.

@@ -1,5 +1,7 @@
# -*- coding: utf-8 -*-

"""Module for up logging set up."""
Copy link
Member

Choose a reason for hiding this comment

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

The grammar isn't correct. What are you trying to say?

Module for setting up logging.

@hackebrot
Copy link
Member

Thank you for your contribution @meahow! 🙇

@hackebrot hackebrot removed the waiting-for-contributor Waiting for answer from original contributor. label Nov 25, 2017
@hackebrot hackebrot merged commit 092cf2b into cookiecutter:master Nov 25, 2017
hackebrot added a commit that referenced this pull request Nov 25, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code style This issue/PR relates to the project code style modification documentation This issue/PR relates to or includes documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants