1473406 - all *scripts should use similar docstrings for consistency

Status: NEW

(Release Engineering :: Release Automation: Other, enhancement)

Description

[Mihai Tabara [:mtabara]⌚️GMT]

A good candidate is the Google code docstrings here[1].
We have 10 *scripts based on scriptworker, we should do that for all of them.

[1]: http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

Comment 1

[Simon Fraser [:sfraser] ⌚️GMT]

For anyone wishing to help out, these are the repositories:

https://github.com/mozilla-releng/addonscript
https://github.com/mozilla-releng/balrogscript
https://github.com/mozilla-releng/beetmoverscript
https://github.com/mozilla-releng/bouncerscript
https://github.com/mozilla-releng/pushapkscript
https://github.com/mozilla-releng/pushsnapscript
https://github.com/mozilla-releng/scriptworker
https://github.com/mozilla-releng/shipitscript
https://github.com/mozilla-releng/signingscript
https://github.com/mozilla-releng/treescript

Comment 2

[Aki Sasaki (not active)]

All in https://github.com/mozilla-releng/scriptworker-scripts/ now.

Comment 3

[Andrew Halberstadt [:ahal]]

This is probably still worth doing.. however if we're going to do a concerted effort to standardize things like this, I think the scope should be much broader..

1. Let's be consistent across all Releng projects, not just scriptworker-scripts.
2. Let's standardize all linting / formatting / type checking / etc, not just docstrings.

This would probably be best implemented as a Releng RFC. I may come back and close this in favour of a broader bug later on.