Improve README formatting with highlighted blocks - #1055
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s readme.md to improve readability by switching to consistent Markdown headings, adding fenced code blocks for examples, and clarifying terminology (e.g., expanding abbreviations and formatting symbol/file names as inline code).
Changes:
- Convert legacy Setext-style headings to ATX (
#/##/###) headings. - Add fenced code blocks (XML/C++/shell) and inline-code formatting for symbols, macros, and filenames.
- Update wording to expand abbreviations (e.g., RTTI/STL) and clarify a few descriptions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| and uses far fewer memory allocations. | ||
|
|
||
| TinyXML-2 has no requirement or support for STL. | ||
| TinyXML-2 has no dependency on the C++ Standard Library, and does not adapt any |
There was a problem hiding this comment.
The sentence says TinyXML-2 "does not adapt" C++ Standard Library collection types; this reads like a word-choice typo (it likely means it does not adopt/use them). Consider changing "adapt" to "adopt" to match the intended meaning.
| TinyXML-2 has no dependency on the C++ Standard Library, and does not adapt any | |
| TinyXML-2 has no dependency on the C++ Standard Library, and does not adopt any |
There was a problem hiding this comment.
I don't agree with the suggestion here, as I think "adapt" is reasonable wording. I will, however, add "or use" to make it clear that we are referring to usage of C++ Standard Library collection classes.
|
I've applied the suggestion about capitalising "GitHub", but did not change "adapt" to "adopt". I did however change it to "adapt or use", to make it clearer the relation it has with the C++ standard library collections (namely that it does not use them at all). |
- Use uint32_t instead of unsigned long for UCS values - Add MAX_CODE_POINT check (0x10FFFF) to prevent overflow - Remove unnecessary TIXMLASSERT checks that don't prevent overflow Upstream: leethomason/tinyxml2#1055 Generated-By: uos/glm-5.1 Co-Authored-By: hudeng <hudeng@deepin.org>
This PR is the first part of #1051. This improves some wording (such as replacing abbreviations with full names) and clarifications, and adds highlighted blocks and verbatim text for symbol names and file names.