misc: Improve TwiML XML Docs#681
Conversation
|
C'mon Twilio folks, this code contribution has been ready to merge on the internal repo and public repo for 6 months. The longer you let these things rot, the more conflicts will arise. |
|
✌️ |
|
Hello @Swimburger! Sincere apologies from my side for missing this one. I would request you to re-open this and I'd be happy to help your contributions get merged. I will be looking at this on priority. Thanks! Since these are auto-generated files, we would need to do similar change in the internal tool as well. I'll check with that as well |
Correct, I made a PR internally for this change too when I worked at Twilio. |
All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.
Fixes
Code generated from internal tool. Creating this as a draft, as the previous PRs were reverted and this generated code contains the same reverted code generation.
I dug into this mainly because of the numerous warning of incorrect XML docs when building this solution.
The main issue was the contents of the XML docs wouldn't be XML escaped, and any documentation related to TwiML would often embed XML inside XML Docs.
This issue has been resolved by XML escaping the contents.
Other optimizations:
//not///This reduces the # of warnings from 1447 to 1223. Since this XML doc change is only applied to TwiML, the API XML docs generated from OpenAPI may still have similar issues.
Checklist