Skip to content
This repository has been archived by the owner. It is now read-only.

Fixed valid docstrings to comply with PEP 257 #2726

Closed
wants to merge 1 commit into from
Closed

Fixed valid docstrings to comply with PEP 257 #2726

wants to merge 1 commit into from

Conversation

@ihatecsv
Copy link
Contributor

@ihatecsv ihatecsv commented May 8, 2019

What I have added/changed is:

Modifying docstrings to comply with PEP 257. This primarily includes changing descriptions (returns x) to commands (return x).

The goal of my change is:

Introduce a uniform and standard docstring format to all code contributed in this project!

What I have tested about my change is:

Ensure no code in Cuckoo is dependent on the value of __doc__.

@ihatecsv
Copy link
Contributor Author

@ihatecsv ihatecsv commented May 8, 2019

@jbremer looks like all PR builds are failing, might want to take a look at it!

@jbremer
Copy link
Member

@jbremer jbremer commented Jul 6, 2019

This has been manually merged into the 2.0.7 release, thanks!

@jbremer jbremer closed this Jul 6, 2019
@jbremer jbremer reopened this Jul 6, 2019
@jbremer jbremer closed this Jul 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants