Version 0.9.24

[jackdewinter]

Summary by Sourcery

Release version 0.9.24, focusing on improvements for Rule Md031 and nested container handling. Introduce a new helper class for container-based indenting, fix list start issues, and address deeply nested container problems. Update the changelog and increment the library version.

New Features:

• Introduce a new helper class to assist in tracking lines to container tokens for container-based indenting, crucial for Rule Md031 and useful for Md027 logic.

Bug Fixes:

• Fix issue with some list starts not being accounted for properly when grouped together on the same line.
• Fix issues with more deeply nested containers as reported in issues 1166, 1167, and 1168.

Enhancements:

• Add cases to Md031 for SetExt and extra test cases for resolution of other cases.

Documentation:

• Update changelog to reflect changes and improvements in version 0.9.24, including the focus on Rule Md031 and nested container cases.

Chores:

• Update library version to 0.9.24.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request updates the project to version 0.9.24, focusing on improvements to Rule Md031 and container-based indenting. The changes include adding new test cases, fixing issues with nested containers and list starts, and introducing a new helper class for tracking line-to-container token relationships.

Class diagram for the new helper class in version 0.9.24

classDiagram
    class LineToContainerTracker {
        +trackLineToContainer(line: String, containerTokens: List<Token>)
        +getContainerIndentation(line: String): int
        +resetTracker()
    }

    class Token {
        <<interface>>
        +getType(): String
        +getValue(): String
    }

    LineToContainerTracker --> Token : uses

    note for LineToContainerTracker "A new helper class to assist in tracking line to container tokens for container-based indenting."

Loading

File-Level Changes

Change	Details	Files
Update changelog for version 0.9.24	Add a detailed description of the focus and improvements in version 0.9.24 Include information about the new helper class for tracking line-to-container token relationships Mention the continued effort in finding and fixing parsing errors Add a call for user feedback and issue reporting List new additions, including cases for Md031 and a new helper class Update fixed issues, including improvements to MD027 and nested list handling Add information about fixes for deeply nested containers	newdocs/src/changelog.md
Increment version number	Update version from '0.9.23' to '0.9.24'	pymarkdown/version.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @jackdewinter - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 2 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue (documentation): Fix typo: 'proveded' should be 'proved'

[sourcery-ai]

suggestion (documentation): Consider providing more specific details for each issue

It might be helpful for users to understand what specific problems were addressed in issues 1166, 1167, and 1168. If they're closely related, you could explain the relationship.

Suggested change

	- [Issue 1166](https://github.com/jackdewinter/pymarkdown/issues/1166)
	- [Issue 1167](https://github.com/jackdewinter/pymarkdown/issues/1167)
	- [Issue 1168](https://github.com/jackdewinter/pymarkdown/issues/1168)
	- fixed issue with more deeply nested
	- fixed issue with more deeply nested containers
	[Issue 1166](https://github.com/jackdewinter/pymarkdown/issues/1166)
	- Fixed handling of list starts when grouped on the same line
	[Issue 1167](https://github.com/jackdewinter/pymarkdown/issues/1167)
	- Improved parsing of nested list structures
	[Issue 1168](https://github.com/jackdewinter/pymarkdown/issues/1168)
	- Resolved issues with deeply nested containers in complex layouts

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (41bcdae) to head (d9e6152).
Report is 22 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #1228   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          191       191           
  Lines        21037     21037           
  Branches      2683      2683           
=========================================
  Hits         21037     21037           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.