Add missing docstrings to Python classes and methods

[phabricator-migrator]

Information

ID: 184
PHID: PHID-TASK-tr54unslb2kptgnzudh3
Author: WhonixQubes
Status at Migration Time: resolved
Priority at Migration Time: Normal

Description

Add missing docstrings to Python classes and methods

#qubes-whonix-next

Old Description:

Excess commenting in WhonixMessageBox Class…

/usr/lib/qubes-whonix/alert

https://github.com/Whonix/qubes-whonix/blob/master/usr/lib/qubes-whonix/alert

nrgaway/qubes-whonix/blob/master/usr/lib/qubes-whonix/alert

class WhonixMessageBox(QtGui.QMessageBox):
    '''
    '''
    def __init__(self, message):

should likely be:

class WhonixMessageBox(QtGui.QMessageBox):
    def __init__(self, message):

Comments

---

nrgaway

2015-02-16 12:21:07 UTC

IMO, The way is currently is listed is more correct that more properly reflect python syntax although it is still not correct in a PEP8 standard sense since the comment doc string is empty, although this does reflect my personal coding style.

Every class and method should have a doc string if wanting to comply with PEP257 conventions.

One deviation to those standards in my coding style is that:

1. I usually provide an empty docstring when creating a method as a placeholder since it improves readability
2. I use single quotes instead of double quotes as many are projects are starting to use.

Therefore the expected change here should be to add a docstring. Maybe you can create that whonix-next tag and add this item to that tag?

---

WhonixQubes

2015-02-16 12:50:37 UTC

Agreed. Will update this ticket now.

---

nrgaway

2015-06-06 16:09:18 UTC

Done.

[[ Added more comments, copyright and cleanup · nrgaway/qubes-whonix@c7c59ba · GitHub | Added more comments, copyright and cleanup · nrgaway/qubes-whonix@c7c59ba · GitHub ]]