New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 671721 link

Starred by 1 user

Issue metadata

Status: Archived
Owner: ----
Closed: Oct 2017
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: ----
Pri: 3
Type: Bug



Sign in to add a comment

[Predator] Add more pre submit rules

Project Member Reported by kateso...@chromium.org, Dec 6 2016

Issue description

[Predator] Add more pre submit rules

Check every function has doc strings. 
Check every test has doc strings (is it too strict?)
Check every module has doc string
Check for double/single blank lines in all the appropriate places
Check for order of imports

 
My main complaint about requiring docstrings on *every* function is that we have a bunch of (abstract) base classes with subclasses. Unless the subclass takes additional parameters or something, the documentation on the base class's version of that method should be sufficient. Otherwise we'll end up with a lot of duplicate documentation— which is problematic because they will eventually get out of sync and cause confusion, so lots of maintenance overhead for (imo) little gain.
Description: Show this description
Labels: -Pri-2 Pri-3
Status: Untriaged (was: Available)
Seems like a P3 at best, but there might be some value here. Moving back to Untriaged to see if there's still interest in this. We should close it if not.
Status: Archived (was: Untriaged)

Sign in to add a comment