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

Added Google-style docstrings to message.py #653

Merged
merged 5 commits into from
Sep 23, 2018

Conversation

archime
Copy link
Contributor

@archime archime commented Sep 23, 2018

Description

Added Google-style docstrings to message.py to partially resolve #532. This is my first PR to the project, so please let me know if I've done anything incorrectly!

Fixes #532

Status

READY

Type of change

  • Documentation (fix or adds documentation)

How Has This Been Tested?

N/A

Checklist:

  • [ X] I have performed a self-review of my own code
  • [ N/A] I have made corresponding changes to the documentation (if applicable)
  • [ N/A] I have added tests that prove my fix is effective or that my feature works
  • [ N/A] New and existing unit tests pass locally with my changes

@codecov
Copy link

codecov bot commented Sep 23, 2018

Codecov Report

Merging #653 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #653   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          21     21           
  Lines        1381   1381           
=====================================
  Hits         1381   1381
Impacted Files Coverage Δ
opsdroid/message.py 100% <ø> (ø) ⬆️

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 6bf72da...9cb1422. Read the comment docs.

Removed whitespace in last empty line. Added newline at end of Attributes section per lint error
@archime
Copy link
Contributor Author

archime commented Sep 23, 2018

@FabioRosado I've got tests passing on this. Let me know if any suggestions related to content of the documentation.

Copy link
Member

@FabioRosado FabioRosado left a comment

Choose a reason for hiding this comment

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

This is an amazing job thank you so much for working on this!

The docstrings are looking pretty great and quite self-explanatory 👍

One thing that I noticed is that Google docstring style uses docstrings like this:

param1 (int): The first parameter.

I am inclined to have this being changed on your PR, but we have an ongoing discussion about PEP 484 and typeints so I am deciding to keep everything like it is.

I know that this is your first PR but we would like to know your opinion about typehints (located on issue #639).

Finally, we give stickers for new contributors, if you would like to get some, please send your home address to opsdroid twitter account and we will send some 😄

Again thank you so much for working on this 👍

@FabioRosado FabioRosado merged commit 031f493 into opsdroid:master Sep 23, 2018
@jacobtomlinson
Copy link
Member

Ping me your address via DM on Twitter or Gitter and I'll post you some opsdroid stickers!

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.

Add Google Style Docstrings
3 participants