github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doclint] lint events

Browse Source 
This patch:
- adds event linting to the doclint
- improves `api.md` to add events and more information about
  classes reported by events.

References #14.
This commit is contained in:
Andrey Lushnikov
2017-07-14 13:03:21 -07:00
parent ac75455983
commit 6eac22dd87
12 changed files with 213 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
utils/doclint/test/golden/07-sorting.txt
View File

@@ -1,3 +1,5 @@
[MarkDown] Events should go first. Event 'b' in class Foo breaks order
[MarkDown] Constructor of Foo should go before other methods
[MarkDown] Foo.ddd breaks alphabetic member sorting inside class Foo
[MarkDown] Foo.ccc() breaks alphabetic member sorting inside class Foo
[MarkDown] Event 'c' in class Foo breaks alphabetic ordering of events
[MarkDown] Foo.ddd breaks alphabetic ordering of class members.
[MarkDown] Foo.ccc() breaks alphabetic ordering of class members.

2
utils/doclint/test/golden/09-event-errors.txt Normal file
View File

@@ -0,0 +1,2 @@
[MarkDown] Non-existing event found in class Foo: 'stop'
[MarkDown] Event not found in class Foo: 'finish'