Updated PubSub docs, removing unused types + top-level comments #1117
Conversation
This file contains hidden or 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
TheIronDev force-pushed the tystark.pubsub-docs-strike-back-with-a-vengeance branch from 39cc50a to 4bfb2cb Compare 
joehan approved these changes May 10, 2022
Member
joehan left a comment
joehan left a comment There was a problem hiding this comment.
Some nits, but I see that this is copied from the linked docs, so feel free to ignore
src/v2/providers/pubsub.ts Outdated
| | ||
| /** | ||
| * A PubSub Topic is: | ||
| * Google Cloud's Pub/Sub is a globally distributed message bus that automatically scales as you need it. |
Member
There was a problem hiding this comment.
I think this should be just Google Cloud Pub/Sub
src/v2/providers/pubsub.ts Outdated
| * Google Cloud's Pub/Sub is a globally distributed message bus that automatically scales as you need it. | ||
| * You can create a function ({@link onMessagePublished}) that handles Pub/Sub events by using functions.pubsub. | ||
| * | ||
| * You can trigger a function whenever a new Pub/Sub message is sent to a specific topic. |
Member
There was a problem hiding this comment.
Nit: 'This functions triggers whenever a new Pub/Sub...`
Member
There was a problem hiding this comment.
@egilmorez may have opinions, but pub/sub should probably be lower case since it's not the product name.
Contributor Author
There was a problem hiding this comment.
Makes sense, updated!
inlined approved these changes May 10, 2022
src/v2/providers/pubsub.ts Outdated
| | ||
| /** | ||
| * A PubSub Topic is: | ||
| * Google Cloud's Pub/Sub is a globally distributed message bus that automatically scales as you need it. |
src/v2/providers/pubsub.ts Outdated
| * Google Cloud's Pub/Sub is a globally distributed message bus that automatically scales as you need it. | ||
| * You can create a function ({@link onMessagePublished}) that handles Pub/Sub events by using functions.pubsub. | ||
| * | ||
| * You can trigger a function whenever a new Pub/Sub message is sent to a specific topic. |
Member
There was a problem hiding this comment.
@egilmorez may have opinions, but pub/sub should probably be lower case since it's not the product name.
TheIronDev force-pushed the tystark.pubsub-docs-strike-back-with-a-vengeance branch from a24de32 to 8ecaa39 Compare Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Updated PubSub docs, removing unused types + top-level comments