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

[Service Bus] Fix docs generated in Typedoc #11346

Closed
HarshaNalluru opened this issue Sep 18, 2020 · 1 comment
Closed

[Service Bus] Fix docs generated in Typedoc #11346

HarshaNalluru opened this issue Sep 18, 2020 · 1 comment
Labels
Client This issue points to a problem in the data-plane of the library. good first issue This issue tracks work that may be a good starting point for a first-time contributor help wanted This issue is tracking work for which community contributions would be welcomed and appreciated Service Bus

Comments

@HarshaNalluru
Copy link
Member

Following is a sceenshot from the generated docs with typedoc
image
https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-service-bus/7.0.0-preview.6/index.html
logger, isError and toAmqpAnnotatedMessage are meant to be internal and are not exported through index.ts, however they show up in the docs.

TODO: Update the JSdoc comments for these methods/classes/interfaces with @ignore and @internal tags to hide them in the generated type docs.
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Sep 18, 2020
@ramya-rao-a ramya-rao-a added Client This issue points to a problem in the data-plane of the library. Service Bus labels Sep 21, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Sep 21, 2020
@ramya-rao-a ramya-rao-a added good first issue This issue tracks work that may be a good starting point for a first-time contributor help wanted This issue is tracking work for which community contributions would be welcomed and appreciated needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Sep 21, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Sep 21, 2020
@ramya-rao-a ramya-rao-a added this to the Backlog milestone Sep 21, 2020
@mohsin-mehmood mohsin-mehmood mentioned this issue Sep 23, 2020
Merged
@HarshaNalluru
Copy link
Member Author

Done with #11427

@xirzec xirzec removed this from the Backlog milestone May 17, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Client This issue points to a problem in the data-plane of the library. good first issue This issue tracks work that may be a good starting point for a first-time contributor help wanted This issue is tracking work for which community contributions would be welcomed and appreciated Service Bus
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@xirzec @HarshaNalluru @ramya-rao-a