jackdewinter / pymarkdown

MIT License
75 stars 17 forks source link

Version 0.9.24 #1228

Closed jackdewinter closed 1 month ago

jackdewinter commented 1 month ago

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:

Bug Fixes:

Enhancements:

Documentation:

Chores:

sourcery-ai[bot] commented 1 month ago

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."

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](https://app.sourcery.ai) 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](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).
codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1228 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 191 191 Lines 21037 21037 Branches 2683 2683 ========================================= Hits 21037 21037 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.