OCA / pylint-odoo / 699
98%

DEFAULT BRANCH: master
Ran
Jobs 6
Files 7
Run time 6min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
699

push

travis-ci

pedrobaeza 
Jslint jsdoc relax (#209)

* Update ES style conventions

- Allow bitwise operators.
- Allow implicit coercion when using `~`. See https://github.com/getify/You-Dont-Know-JS/blob/master/types%20&%20grammar/ch4.md#the-curious-case-of-the- to know why it's useful.
- Require inline block spacing.
- Require multiline dangling commas. Nobody cares about IE8.
- Limit line width to 80 characters, except for the `odoo.define()` one, which tends to require extra space.
- Require spaces after commas and comments.
- Require consistent indentation of 4 spaces.
- Require consistent line breaks inside braces.
- Require consistent newlines in object property declarations.
- Requre `"use strict"`.
- Require sorting imports.
- Require consistent spacing around blocks and keywords.
- Comments must start with upper case.
- Block comments require a space before.
- Relax some rules for jsdoc comments, but warn if it is missing for any declared method. See below for details.

About the jsdoc relaxation, the need comes from the fact that sometimes you're extending another object, and thus you don't need to reexplain everything if it is explained in the parent class.

A common coding pattern is:

```js
return this._super.apply(this, arguments);
```

In such cases, it should be enough to declare the return type, since further descriptions should be found in the upstream class.

Another common pattern is reusing upstream parameters, or using parameters with names that are specific enough so as to not require a description, so the requirement of param description is relaxed here too.

In any case, remember that when you're overriding a method, you can just do a jsdoc like this:

```js
/**
 * @override
 */
overriden_method: function (param1, param2) {
    // Some logic here
    return this._super.apply(this, arguments);
}
```

The `@override` keyword above removes any further requirements of manually copying anything from upstream's jsdoc. Use it!

1145 of 1145 relevant lines covered (100.0%)

5.99 hits per line

Jobs
ID Job ID Ran Files Coverage
1 699.1 (TOXENV=py27-pylint14) 0
100.0
 Travis Job 699.1
2 699.2 (TOXENV=py27-pylint20) 0
100.0
 Travis Job 699.2
3 699.3 (TOXENV=py35-pylint14) 0
99.83
 Travis Job 699.3
4 699.4 (TOXENV=py35-pylint20) 0
99.83
 Travis Job 699.4
5 699.5 (TOXENV=py37-pylint14) 0
99.83
 Travis Job 699.5
6 699.6 (TOXENV=py37-pylint20) 0
99.83
 Travis Job 699.6
Source Files on build 699
Detailed source file information is not available for this build.