honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

build(docs-infra): allow usage notes on decorator option properties (#26039) 

PR Close #26039
This commit is contained in:
Pete Bacon Darwin 2018-09-20 20:48:18 +01:00 committed by Kara Erickson
parent 206ae7a233
commit 8ac4dd6447
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
aio/tools/transforms/angular-api-package/index.js vendored
View File

@ -253,7 +253,12 @@ function addAllowedPropertiesRules(checkContentRules, API_CONTAINED_DOC_TYPES) {
const ruleSet = checkContentRules.docTypeRules[docType] = checkContentRules.docTypeRules[docType] || {};
const rules = ruleSet['usageNotes'] = ruleSet['usageNotes'] || [];
rules.push((doc, prop, value) => value && !isMethod(doc) &&
rules.push((doc, prop, value) =>
value &&
// methods are allowed to have usage notes
!isMethod(doc) &&
// options on decorators are allowed to ahve usage notes
!(doc.containerDoc && doc.containerDoc.docType === 'decorator') &&
`Invalid property: "${prop}" is not allowed on "${doc.docType}" docs.`);
});
}