Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit cc689ce

Browse files
chalinwardbell
authored andcommitted
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.
1 parent 285ecf4 commit cc689ce

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

tools/api-builder/docs-package/processors/addNotYetDocumentedProperty.js

+2-3
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre
2323
}
2424

2525
if (doc.notYetDocumented) {
26-
// TODO: (ericjim) should I remove this?
27-
log.warn(createDocMessage("Not yet documented", doc));
26+
log.info(createDocMessage("Not yet documented", doc));
2827
}
2928
});
3029

@@ -35,4 +34,4 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre
3534

3635
function notYetDocumented(doc) {
3736
return !doc.noDescription && doc.description.trim().length == 0;
38-
}
37+
}

0 commit comments

Comments
 (0)