[dev tool] Add design docs for README snippets #24537
Merged
Conversation
This file contains 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
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
Co-authored-by: Will Temple <witemple@microsoft.com>
mpodwysocki
commented
Mar 3, 2023
|
Do you think it may be worth adding some assertions to the snippet test? The assertions could be ignored by dev-tool when extracting, but it will help us validate that the snippet not only runs, but that it still does what it was designed to do. |
@joheredi there is no prior art for example in the C# code to test whether it compiles and doesn't crash. There should already be unit and integration level tests that should have the assertions. |
|
Yeah, that's fair! |
joheredi
approved these changes
Mar 27, 2023
|
/check-enforcer override |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Packages impacted by this PR
Issues associated with this PR
Describe the problem that is addressed by this PR
Adds a design document on how we are going to do snippet extraction for READMEs and source code.
What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?
Are there test cases added in this PR? (If not, why?)
Provide a list of related PRs (if any)
Command used to generate this PR:**(Applicable only to SDK release request PRs)
Checklists