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:
parent
285ecf495f
commit
cc689ce980
|
@ -23,8 +23,7 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre
|
|||
}
|
||||
|
||||
if (doc.notYetDocumented) {
|
||||
// TODO: (ericjim) should I remove this?
|
||||
log.warn(createDocMessage("Not yet documented", doc));
|
||||
log.info(createDocMessage("Not yet documented", doc));
|
||||
}
|
||||
});
|
||||
|
||||
|
@ -35,4 +34,4 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre
|
|||
|
||||
function notYetDocumented(doc) {
|
||||
return !doc.noDescription && doc.description.trim().length == 0;
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue