History

Andrey Lushnikov dc032b42b9 Introduce polymorphic page.waitFor method This patch: - introduces page.waitForSelector to wait for the selector to appear - introduces polymorphic page.waitFor method, which accepts either string (and in this case is a shortcut for page.waitForSelector) or number (and in this case it's a promisified timeout). References #91.		2017-07-21 12:54:04 -07:00
..
test	Introduce polymorphic page.waitFor method	2017-07-21 12:54:04 -07:00
.gitignore	[doclint] move doclint testing to golden	2017-07-13 11:17:02 -07:00
cli.js	Automatically generate table-of-contents for markdown	2017-07-21 11:12:05 -07:00
Documentation.js	[doclint] lint events	2017-07-14 23:52:13 -07:00
JSBuilder.js	Automatically generate table-of-contents for markdown	2017-07-21 11:12:05 -07:00
lint.js	Introduce polymorphic page.waitFor method	2017-07-21 12:54:04 -07:00
MDBuilder.js	Automatically generate table-of-contents for markdown	2017-07-21 11:12:05 -07:00
README.md	[doclint] Move doclint under utils/	2017-07-13 00:28:52 -07:00

DocLint

Doclint is a small program that lints Puppeteer's documentation against Puppeteer's source code.

Doclint works in a few steps:

Read sources in lib/ folder, parse AST trees and extract public API
Read sources in docs/ folder, render markdown to HTML, use puppeteer to traverse the HTML and extract described API
Compare one API to another

Doclint is also responsible for general markdown checks, most notably for the table of contents relevancy.

Running

npm run doc

Doclint has its own set of jasmine tests, located at utils/doclint/test folder.

To execute tests, run:

npm run test-doclint