Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Apr 7, 2020
Merged

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

merged 2 commits into from
Apr 7, 2020

Conversation

@laurenzlong
Copy link
Contributor

@laurenzlong laurenzlong commented Mar 31, 2020

Description

Code sample
egilmorez
egilmorez reviewed Mar 31, 2020
View reviewed changes
egilmorez
egilmorez reviewed Mar 31, 2020
View reviewed changes
egilmorez
egilmorez reviewed Mar 31, 2020
View reviewed changes
egilmorez
egilmorez reviewed Mar 31, 2020
View reviewed changes
egilmorez
egilmorez reviewed Mar 31, 2020
View reviewed changes
Copy link
Contributor

@egilmorez egilmorez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some questions/clarifications, thanks!
@laurenzlong
Copy link
Contributor Author

laurenzlong commented Mar 31, 2020

Thanks for the review Eric! Is there any chance you can try to stage this, so we can see what it looks like?
@laurenzlong laurenzlong marked this pull request as ready for review April 2, 2020 17:24
@egilmorez
Copy link
Contributor

egilmorez commented Apr 7, 2020

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
Copy link
Contributor

egilmorez commented Apr 7, 2020

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

Thanks!
@egilmorez egilmorez merged commit f1ced37 into launch.handler-docs Apr 7, 2020
laurenzlong added a commit that referenced this pull request May 1, 2020
@laurenzlong @egilmorez @rachelsaunders
Revise docs for handler namespace (#680)
b1f9b5a 
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes

3 participants

@laurenzlong @egilmorez @googlebot