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.

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

Where is Javadoc for Azure Java Libraries #39948

Closed
CaymanTurtleBeach opened this issue Apr 28, 2024 · 4 comments
Closed

Where is Javadoc for Azure Java Libraries #39948

CaymanTurtleBeach opened this issue Apr 28, 2024 · 4 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. issue-addressed The Azure SDK team member assisting with this issue believes it to be addressed and ready to close. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Tables

Comments

@CaymanTurtleBeach
Copy link

Type of issue

Missing information

Description

Why does Microsoft persist in not making links to Javadoc style documentation for Azure Java SDKs PROMINENT - especially when its own format style often omits key elements.

To wit: (from https://learn.microsoft.com/en-us/java/api/com.azure.data.tables.tableserviceclient?view=azure-java-stable#com-azure-data-tables-tableserviceclient-createtable(java-lang-string)

Method Details

Create Table
createTable
public TableClient createTable(String tableName)

Creates a table within the Tables service.

Code Samples

Creates a table. Prints out the details of the created table.

Java

Copy
TableClient tableClient = tableServiceClient.createTable("myTable");

 System.out.printf("Table with name '%s' was created.", tableClient.getTableName());
Parameters:

tableName - The name of the table to create.
Returns:

A [TableClient](https://learn.microsoft.com/en-us/java/api/com.azure.data.tables.tableclient?view=azure-java-stable) for the created table.

NOT A WORD ABOUT THE EXCEPTION THAT IS THROWN IF A TABLE WITH THE NAME tableName ALREADY EXISTS.

Where is Javadoc??? Java developers should not have to search for Javadoc and slog through all the cruft returned just to get documentation that is correct and formatted consistent with virtually all significant public Java libraries.

Page URL

https://learn.microsoft.com/en-us/java/api/overview/azure/data-tables-readme?view=azure-java-stable

Content source URL

https://github.com/Azure/azure-docs-sdk-java/blob/master/docs-ref-services/latest/data-tables-readme.md

Document Version Independent Id

c2ca723f-f9ca-302a-6a30-9426fdb8b0cc

Article author

@azure-sdk

Metadata

  • ID: a618277f-b2f6-1c9d-551c-14e0adea3738
  • Service: tables
@github-actions github-actions bot added Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-team-attention This issue needs attention from Azure service team or SDK team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Tables labels Apr 28, 2024
Copy link

Thank you for your feedback. Tagging and routing to the team member best able to assist.

@jairmyree
Copy link
Member

jairmyree commented Apr 29, 2024

@CaymanTurtleBeach Thank you for reaching out. I will look into your issue and respond shortly.

@jairmyree
Copy link
Member

@CaymanTurtleBeach There is a known issue with the learn.microsoft.com documentation where the exceptions are not being documented. For more accurate documentation, I would suggest that you use the Javadocs that come bundled with each release of our libraries: link to maven. They can be directly downloaded from maven and viewed within your browser or viewed within an IDE capable of downloading and displaying dependency Javadocs such as Intellij.

@jairmyree jairmyree added the issue-addressed The Azure SDK team member assisting with this issue believes it to be addressed and ready to close. label May 7, 2024
Copy link

github-actions bot commented May 7, 2024

Hi @CaymanTurtleBeach. Thank you for opening this issue and giving us the opportunity to assist. We believe that this has been addressed. If you feel that further discussion is needed, please add a comment with the text "/unresolve" to remove the "issue-addressed" label and continue the conversation.

@github-actions github-actions bot removed the needs-team-attention This issue needs attention from Azure service team or SDK team label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. issue-addressed The Azure SDK team member assisting with this issue believes it to be addressed and ready to close. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Tables
Projects
None yet
Development

No branches or pull requests

2 participants