style(aio): fix comment on postProcessHtml processor

Fixes https://github.com/angular/angular/pull/16336#discussion_r113891332
This commit is contained in:
Peter Bacon Darwin 2017-04-28 14:07:21 +01:00 committed by Matias Niemelä
parent ca17d4f639
commit 3b80472bad
1 changed files with 2 additions and 2 deletions

View File

@ -9,8 +9,8 @@ const rehype = require('rehype');
* See https://github.com/wooorm/rehype
*
* Each plugin is a factory function that will be called with the "rehype" engine as `this`.
* The factory should return a function that takes a HAST and returns a `boolean` or `undefined`.
* The HAST can be mutated by the this function.
* The factory should return a "transform" function that takes a HAST and returns a `boolean` or `undefined`.
* The HAST can be mutated by the "transform" function.
* If `false` is returned then the processing stops with that plugin.
*
* @property docTypes {string[]} the `docTypes` of docs that should be post-processed