fix(dotnet): documentation strings sometimes invalid #1127
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
The XML-doc generation for the C# classes was not correctly accounting for the necesaity to encode certain characters (e.g: `&`) for use in XML context, which resulted in invalid documentation strings being generated. Additionally, slugified parameter names need to be represented in their "pure" form (without the `@` slug) in the `<param>` tag. This uses `xmlbuilder` to generate the minimal XML tag pairs, ensuring the content is correctly encoded. The `@` slug is rmeoved from `<param>` tags, and the `<summary>` block is generated inconditionally (even if empty), silencing a C# warning about there being no documentation XML on a public member. Finally, moved some `await` in `for` loops out, to hopefully positively impact the generation speeds overall.
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
MrArnoldPalmer
approved these changes
Dec 16, 2019
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
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.
The XML-doc generation for the C# classes was not correctly accounting
for the necesaity to encode certain characters (e.g:
&) for use in XMLcontext, which resulted in invalid documentation strings being generated.
Additionally, slugified parameter names need to be represented in their
"pure" form (without the
@slug) in the<param>tag.This uses
xmlbuilderto generate the minimal XML tag pairs, ensuringthe content is correctly encoded. The
@slug is removed from<param>tags, and the
<summary>block is generated inconditionally (even ifempty), silencing a C# warning about there being no documentation XML on
a public member.
Finally, moved some
awaitinforloops out, to hopefully positivelyimpact the generation speeds overall.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.