diff options
| author |  fzaiser <fzaiser@google.com> | 2017-10-16 14:39:08 +0200 |
|---|---|---|
| committer |  Jakob Buchgraber <buchgr@google.com> | 2017-10-16 17:49:04 +0200 |
| commit | 384871626bbec1eac32091e29e9230f849790877 (patch) | |
| tree | 72c3d3498b58d0bc3aae72a096131eb533191a27 /scripts | |
| parent | d063524537b16fe5144ba92ea0b3fea39443d51a (diff) | |
Skylint: docstring format: mandatory order of description and sections.
Each docstring should include
1. a summary line
2. a more extensive description (optional)
3. an 'Args' section (if there are parameters)
4. a 'Returns' section (if there is a return value)
5. a 'Deprecated' section (if it is deprecated)
in this order. If the order is different, there will be a warning.
The same order is recommended for Java (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#orderoftags).
RELNOTES: none
PiperOrigin-RevId: 172313475
Diffstat (limited to 'scripts')
0 files changed, 0 insertions, 0 deletions