Skip to content

Conversation

@Sxribe
Copy link

@Sxribe Sxribe commented Jun 26, 2020

This file was cluttered with absolutely useless comments that did nothing except make the file hard to read. This file is one of the few examples that shows how to use cors with firebase functions.

For example:

// [START readBodyParam] format = req.body.format; // [END readBodyParam]

This code snippet provides zero additional information, however it clutters the code.

Starting the file with [START all] and ending with [END all] is once again an example of a useless comment. It's obvious that the code starts there, and ends there.

Comments should be used only for documentation, clarification, and nuances/things that need to be pointed out to future contributors.

This file was cluttered with absolutely useless comments that did nothing except make the file hard to read. This file is one of the few examples that shows how to use cors with firebase functions. For example: ```js // [START readBodyParam] format = req.body.format; // [END readBodyParam] ``` This code snippet provides **zero** additional information, however it clutters the code. To make matters worse, this exact case is repeated again, for the same code, with no change. Comments should be used only for documentation, clarification, and nuances/things that need to be pointed out to future contributors.
@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@Sxribe
Copy link
Author

Sxribe commented Jun 26, 2020

@googlebot I signed it!

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@jhuleatt
Copy link
Collaborator

@Sxribe these comments are used by a script that inserts code from these samples into the Firebase docs, so we can't remove them. Apologies for the clutter.

@jhuleatt jhuleatt closed this Dec 15, 2020
@Sxribe
Copy link
Author

Sxribe commented Dec 17, 2020

Makes sense, thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3 participants