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

chore(api doc gen): log 'no api docs' as info not warning 

closes #1860
There are too many undocumented interfaces to consider lack of API docs
in a source file to be worth a warning. The original author even
questions whether there should be such a warning. It is now logged at
the `info` level.
This commit is contained in:
Patrice Chalin 2016-07-08 12:41:48 -07:00 committed by Ward Bell
parent 285ecf495f
commit cc689ce980
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
tools/api-builder/docs-package/processors/addNotYetDocumentedProperty.js
View File

@ -23,8 +23,7 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre
} }
if (doc.notYetDocumented) { if (doc.notYetDocumented) {
// TODO: (ericjim) should I remove this? log.info(createDocMessage("Not yet documented", doc));
log.warn(createDocMessage("Not yet documented", doc));
} }
}); });
@ -35,4 +34,4 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre
function notYetDocumented(doc) { function notYetDocumented(doc) {
return !doc.noDescription && doc.description.trim().length == 0; return !doc.noDescription && doc.description.trim().length == 0;
} }