Add new line break for 'par' section in XML parser, thanks @zyphlar

[JakubAndrysek]

No description provided.

[sourcery-ai]

PR Type: Enhancement

PR Summary: This pull request introduces an enhancement to the XML parser within the mkdoxy project by adding a new line break handling for the 'par' section. It aims to improve the parser's ability to correctly interpret and format sections that require a line break, specifically targeting the 'par' section as defined in the Doxygen documentation. The PR also includes a helpful comment linking to the Doxygen commands manual, providing context and reference for the added functionality.

Decision: Comment

📝 Type: 'Enhancement' - not supported yet.

• Sourcery currently only approves 'Typo fix' PRs.

✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.

No details provided.

✅ Small diff: the diff is small enough to approve with confidence.

No details provided.

General suggestions:

• While the addition of the 'par' key with carriage return and newline characters is a thoughtful approach to handling line breaks, it's important to consider the portability of such a solution across different operating systems. Using os.linesep instead of hardcoding \r\n would ensure that the parser behaves consistently regardless of the operating system it's running on.
• The inclusion of a link to the Doxygen commands manual is commendable as it provides valuable context and reference. It's a good practice to include such comments, especially when introducing changes that are closely related to external documentation or standards.
• Ensure that the rest of the codebase and documentation are updated to reflect this new handling of the 'par' section, if necessary. This helps maintain consistency and clarity throughout the project.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

• X
• Mastodon
• LinkedIn
• Facebook

---

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

[sourcery-ai]

suggestion (llm): The addition of the 'par' key with carriage return and newline characters might not be consistent across all operating systems, especially Unix/Linux where newline is represented as '\n' only. Consider using os.linesep for a more portable solution.