bs-puppeteer
bs-puppeteer copied to clipboard
Meta: Document the API
We are missing doc comments for a lot of the bindings. Adding them really improves the developer experience in the editor and will eventually allow us to generate some API documentation. We'll check off documented modules as they are done.
- [ ] BoundingBox
- [ ] BoxModel
- [ ] Browser
- [ ] BrowserContext
- [ ] BrowserFetcher
- [ ] CDPSession
- [ ] Click
- [x] ConsoleMessage
- [ ] Coverage
- [ ] Dialog
- [ ] ElementHandle
- [ ] Evaluator
- [ ] ExecutionContext
- [ ] Frame
- [ ] FrameBase
- [ ] JSHandle
- [ ] JSMap (may eventually be split off into a separate package)
- [ ] Keyboard
- [ ] Metrics
- [ ] Mouse
- [ ] Navigation
- [ ] Page
- [ ] Puppeteer (partially documented)
- [ ] Request (partially documented)
- [x] Response
- [x] Screenshot
- [x] SecurityDetails
- [ ] Target
- [ ] Touchscreen (and some more binding implementation)
- [ ] Tracing
- [ ] Types
- [ ] Unit
- [ ] Util
- [ ] Worker
For now we should focus on getting the most important information into doc comments on the main functions and types of each modules. Don't worry too much about formatting until things have standardized somewhat. Short doc comments may need to be padded out some until Reason 3.3+ is released with my fix to doc comment formatting before externals (https://github.com/facebook/reason/commit/150299993d0c11c231d36e62abf61f432c2354bb).