Skip to content
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

SubscriberOptions are not documented anywhere #1750

Open
kamalaboulhosn opened this issue Jun 14, 2023 · 1 comment
Open

SubscriberOptions are not documented anywhere #1750

kamalaboulhosn opened this issue Jun 14, 2023 · 1 comment
Assignees
@feywind
Labels
api: pubsub Issues related to the googleapis/nodejs-pubsub API. priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.

Comments

@kamalaboulhosn
Copy link
Contributor

The SubscriberOptions documentation is seemingly not available anywhere other than the source code. We do not define them anywhere in the documentation we link to from our product documentation, though we refer to the type: https://googleapis.dev/nodejs/pubsub/latest/PubSub.html#subscription. We should audit and make sure all necessary types are defined in the documentation.
@kamalaboulhosn kamalaboulhosn added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Jun 14, 2023
@product-auto-label product-auto-label bot added the api: pubsub Issues related to the googleapis/nodejs-pubsub API. label Jun 14, 2023
@feywind feywind added priority: p3 Desirable enhancement or fix. May not be included in next release. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. labels Feb 8, 2024
@hongalex hongalex added type: docs Improvement to the documentation for an API. and removed type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels May 2, 2024
@feywind
Copy link
Collaborator

feywind commented Nov 15, 2024

This has turned out to be a bit of a rabbit-hole, and I'm not entirely convinced that we can make it do the obvious thing. It may have to wait for us to update our docs tooling. I've been working on fixing what I can, here.

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

@feywind feywind

Labels
api: pubsub Issues related to the googleapis/nodejs-pubsub API. priority: p3 Desirable enhancement or fix. May not be included in next release. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kamalaboulhosn @hongalex @feywind