docs: Update pub/sub quickstart to use background event #144
Conversation
| Google Cloud Functions [event](https://cloud.google.com/functions/docs/concepts/events-triggers#events) payloads to `event` and `context` objects. | ||
| These will be passed as arguments to your function when it receives a request. | ||
| Note that your function must use the `event`-style function signature: | ||
|
|
||
| ```python | ||
| def hello(data, context): | ||
| print(data) | ||
| def hello(event, context): | ||
| print(event) | ||
| print(context) | ||
| ``` |
There was a problem hiding this comment.
Usually, we refer to the whole event as an event, (like event and cloudevent), not the first param.
The event we refer to usually has two properties, data, and context. I suggest we keep the same terms here. This is like the docs are currently, and the Node Functions Framework. Although Java uses event.
If we want to use the term event, context, I suggest we do so in a separate PR and have a plan to update the docs at the same time.
There was a problem hiding this comment.
FWIW in most other language samples we use (message, context). I don't think it really matters much TBH
| @@ -13,5 +13,5 @@ | |||
| # limitations under the License. | |||
|
|
|||
|
|
|||
| def hello(data, context): | |||
There was a problem hiding this comment.
I would not update this identifier in this PR. Maybe a separate PR.
| @@ -134,14 +134,14 @@ response instead. | |||
| 1. Create a `main.py` file with the following contents: | |||
|
|
|||
| ```python | |||
| def hello(request): | |||
| return "Hello world!" | |||
| def hello(event, context): | |||
There was a problem hiding this comment.
I would stick to data, context to update this Pub/Sub quickstart. See other comments for more details.
|
@grant The change to |
| @@ -134,14 +134,14 @@ response instead. | |||
| 1. Create a `main.py` file with the following contents: | |||
|
|
|||
| ```python | |||
| def hello(request): | |||
| return "Hello world!" | |||
| def hello(event, context): | |||
Fixes #23, closes #140.