1015765 - Need docstrings for methods

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect, P2)

Description

[RichieRich]

User Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.114 Safari/537.36

Steps to reproduce:

No docstrings


Actual results:

Docstrings either were not present, or left as comments describing methods


Expected results:

Docstrings need to be added to python files

Comment 1

[RichieRich]

Attachment: Need docstrings for methods

Comment 2

[RichieRich]

Attachment: Need docstrings for methods

Comment 3

[Richard Newman [:rnewman]]

RichieRich: you need to get a patch file and attach it to the bug.

https://developer.mozilla.org/en-US/docs/Mercurial_FAQ#How_can_I_generate_a_patch_for_somebody_else_to_check-in_for_me.3F

Comment 4

[RichieRich]

Attachment: original.patch

Comment 5

[Erik Vold [:erikvold] (please needinfo? me)]

I'm not sure it's worth landing this, since we are trying to replace cfx with a new tool, and end of life cfx.

Comment 6

[Gian-Carlo Pascutto [:gcp]]

Unless that new tool has patches that are r+ and ready to land, not landing fixes/enhancements for the existing code is, as a general rule, pretty meh. Because who knows when the replacement will actually make it.

Comment 7

[Erik Vold [:erikvold] (please needinfo? me)]

Comment on attachment 8431908 [details] [diff] [review]
original.patch

We only use spaces, no tabs for indentation.

Comment 8

[Erik Vold [:erikvold] (please needinfo? me)]

(In reply to Erik Vold [:erikvold] [:ztatic] from comment #7)
> Comment on attachment 8431908 [details] [diff] [review]
> original.patch
> 
> We only use spaces, no tabs for indentation.

I'll land the patch with this change.

Comment 9

[RichieRich]

Attachment: spaces.patch

Changed from tabs to spaces

Comment 10

[Will Bamberg [:wbamberg]]

Comment on attachment 8437171 [details] [diff] [review]
spaces.patch

Looks OK to me, and cfx testall says:

10114 of 10114 tests passed.
Total time: 557.046558 seconds
Program terminated successfully.
Total time for all tests: 721.242576 seconds
All tests were successful. Ship it!

Comment 11

[[github robot]]

Commit pushed to master at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/95be1facf55b85ac3938a5cc96e9db59d91b67f8
Merge pull request #1497 from richierichrawr/master

Bug 1015765 - Need docstrings for methods

Comment 12

[Will Bamberg [:wbamberg]]

Thanks!