Skip to content

Commit 68c6cd6

Browse files
committed
docs(code comment): make reference to @template being non-standard tag
docs(contributing): clarify reasons for adhering to AngularJS syntax testing: add back timeouts as still occasionally timing out
1 parent 28c1f3a commit 68c6cd6

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,7 @@ by linking to an issue or giving a full description of what it achieves.
6363

6464
We use [semantic-release](https://github.com/semantic-release/semantic-release)
6565
for preparing releases, so the commit messages (or at least the merge that
66-
brings them into `master`) ought to follow the
67-
[AngularJS commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) with a special format such as `feat: describe new feature`.
66+
brings them into `master`) must follow the
67+
[AngularJS commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) with a special format such as `feat: describe new feature`
68+
in order for the releasing to occur and for the described items to be added
69+
to the release notes.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@
6464
"build": "rm -fr ./dist && NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps",
6565
"create-readme": "gitdown ./.README/README.md --output-file ./README.md && npm run add-assertions",
6666
"lint": "eslint ./src ./test",
67-
"test-cov": "BABEL_ENV=test nyc mocha --recursive --require @babel/register --reporter progress",
68-
"test": "BABEL_ENV=test nyc --reporter text-summary mocha --recursive --require @babel/register --reporter progress"
67+
"test-cov": "BABEL_ENV=test nyc mocha --recursive --require @babel/register --reporter progress --timeout 7000",
68+
"test": "BABEL_ENV=test nyc --reporter text-summary mocha --recursive --require @babel/register --reporter progress --timeout 7000"
6969
},
7070
"nyc": {
7171
"require": [

src/tagNames.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,14 @@ export default {
8989
since: [],
9090
static: [],
9191
summary: [],
92+
93+
// `@template` is not part of standard jsdoc on https://jsdoc.app but is
94+
// used by Closure per:
95+
// https://github.com/google/closure-compiler/wiki/Generic-Types
96+
// and by TypeScript per:
97+
// https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc
9298
template: [],
99+
93100
this: [],
94101
throws: [
95102
'exception'

0 commit comments

Comments
 (0)