Add docstrings for handler.firestore, handler.database, and handler.https #652

laurenzlong · 2020-03-31T22:04:15Z

Description

Code sample

src/handler-builder.ts

egilmorez

Some questions/clarifications, thanks!

laurenzlong · 2020-03-31T23:29:21Z

Thanks for the review Eric! Is there any chance you can try to stage this, so we can see what it looks like?

egilmorez · 2020-04-07T01:18:23Z

Here as requested is a stage of these changes:

https://firebase.devsite.corp.google.com/docs/reference/functions/handler_builder_.handlerbuilder#https

One global suggestion: let's take each sample string and enclose it in this markup:

 * @example
 * ```javascript
 * exports.myFunction = functions.handler.https.onRequest((req, res) => { ... })
 * ```

That will create some whitespace and make everything pretty for the output.

Thanks!

egilmorez · 2020-04-07T01:21:06Z

Or actually, why not merge this as/is and I can apply the formatting like tech writers are supposed to do.

Thanks!

* Adding top-level comment and TOC for functions.handler. (#633) * Adding top-level comment and TOC for functions.handler. * Adding edits from feedback. * Refer specifically to Firebase CLI. * Adding top-level comment and TOC for functions.handler. (#633) * Adding top-level comment and TOC for functions.handler. * Adding edits from feedback. * Refer specifically to Firebase CLI. * Pin "typedoc" version to 0.14.2 (#655) * Add docstrings for handler.firestore, handler.database, and handler.https (#652) * Document a few providers * Remove extra sentence in http function docstring * Crashlytics handler details and example formatting (#656) * Adding comments for Crashlytics handler. * Removing parens for parameters per feedback. * Eg moar handlers (#657) * Adding RC and Analytics handlers. * Adding Storage object handler. * Adding Pub/Sub and Test Lab handlers. * Adding auth handler. * Fixing typo. * Removing async to be consistent among examples. (#658) * handler functions: copy-edits in comments only (#675) * Removing async syntax from Storage handlers. (#678) Co-authored-by: egilmorez <egilmore@google.com> Co-authored-by: rachelsaunders <52258509+rachelsaunders@users.noreply.github.com>

Document a few providers

f2fed27

googlebot added the cla: yes label Mar 31, 2020