Fix GCF Handler documentation. #16284
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We were providing incorrect advice for setting the handler function name when deploying a GCF Lambdex. Correct our incorrect documentation, and misleading logging and expand a code comment to cover what's going on here. Fixes pantsbuild#16242 [ci skip-rust] [ci skip-build-wheels]
jsirois
commented
Jul 23, 2022
| @@ -103,7 +103,7 @@ def complete_platform(rule_runner: RuleRunner) -> bytes: | |||
| { | |||
| "pex_exe/BUILD": dedent( | |||
| """\ | |||
| python_requirement(name="req", requirements=["pex==2.1.66"]) | |||
| python_requirement(name="req", requirements=["pex==2.1.99"]) | |||
There was a problem hiding this comment.
The tests were failing for me since I'm defaulting to Python 3.11 right now. Pex 2.1.66 does not support 3.11.
stuhood
approved these changes
Jul 24, 2022
| @@ -88,4 +88,4 @@ Step 4: Upload to Google Cloud | |||
|
|
|||
| You can use any of the various Google Cloud methods to upload your zip file, such as the Google Cloud console or the [Google Cloud CLI](https://cloud.google.com/functions/docs/deploying/filesystem#deploy_using_the_gcloud_tool). | |||
|
|
|||
| You must specify the handler as `main.handler`. | |||
| You must specify the handler as `handler`. | |||
There was a problem hiding this comment.
The "For example" section above still says main.handler: assuming that that is supposed to be aligned here, it might be good for this line to say something like "as demonstrated in the example above."
There was a problem hiding this comment.
I'm not really following your suggestion, but the "For example" output was no longer accurate. I fixed that just like I was forced to fix it in the tests.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We were providing incorrect advice for setting the handler function name
when deploying a GCF Lambdex. Correct our incorrect documentation and
misleading logging and expand a code comment to cover what's going on
here.
Fixes #16242
[ci skip-rust]
[ci skip-build-wheels]