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

Support Using Tests as Javadoc and README Codesnippets #21902

Closed
alzimmermsft opened this issue May 27, 2021 · 1 comment
Closed

Support Using Tests as Javadoc and README Codesnippets #21902

alzimmermsft opened this issue May 27, 2021 · 1 comment
Assignees
@mssfang
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.
Milestone
[2021] December

Comments

@alzimmermsft
Copy link
Member

Update Javadoc and README codesnippet usage to allow the inclusion of test code as the codesnippet source code. Currently, codesnippet source code only ensures compilation is valid but does not ensure runtime behavior is expected.
@alzimmermsft alzimmermsft added EngSys This issue is impacting the engineering system. Client This issue points to a problem in the data-plane of the library. labels May 27, 2021
@alzimmermsft alzimmermsft added this to the [2021] September milestone May 27, 2021
@alzimmermsft alzimmermsft mentioned this issue May 27, 2021
Closed
8 tasks
@alzimmermsft alzimmermsft mentioned this issue Jun 18, 2021
Closed
52 tasks
@alzimmermsft
Copy link
Member Author

Closing as the new codesnippet-maven-plugin allows each SDK to configure the path where codesnippets are pulled. This issue may be followed up by having a central issue to request all SDKs to using test code for snippets.

@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

@mssfang mssfang

Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system.
Projects
None yet
Milestone
[2021] December
Development

No branches or pull requests
2 participants
@mssfang @alzimmermsft