Skip to content

Fix section depth in markdown template#664

Merged
adiroiban merged 6 commits intotwisted:trunkfrom
flying-sheep:fix-md-section-depth
Mar 11, 2025
Merged

Fix section depth in markdown template#664
adiroiban merged 6 commits intotwisted:trunkfrom
flying-sheep:fix-md-section-depth

Conversation

@flying-sheep
Copy link
Copy Markdown
Contributor

@flying-sheep flying-sheep commented Aug 23, 2024 •
edited
Loading

Description

Fixes #663

Checklist

  • Make sure changes are covered by existing or new tests.
  • For at least one Python version, make sure test pass on your local environment.
  • Create a file in src/towncrier/newsfragments/. Briefly describe your
    changes, with information useful to end users. Your change will be included in the public release notes.
  • Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
  • Ensure docs/tutorial.rst is still up-to-date.

@flying-sheep flying-sheep marked this pull request as ready for review August 23, 2024 14:37
@flying-sheep flying-sheep requested a review from a team as a code owner August 23, 2024 14:37
adiroiban
adiroiban reviewed Aug 23, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR.

Changes looks good... but this might be considered a backward incompatible change.

Users that already have NEWS files, will have them generated with H3 for previous releases.

I think that this might be ok, but we should communicate this change to end users.

I was expected to also see some updates to the test docstrings, to explain that the H2 render is important.

I hope that someone who cares about MD support in towncrier will have some time and do a review of this PR

@adiroiban adiroiban requested a review from a team August 23, 2024 15:09
@flying-sheep flying-sheep mentioned this pull request Aug 23, 2024
Closed
@flying-sheep
Copy link
Copy Markdown
Contributor Author

flying-sheep commented Aug 23, 2024

Hi @adiroiban, I commented a bit on the bigger problem here: #663

maybe you’d like to chime in there before I invest more time into this fix

adiroiban
adiroiban approved these changes Mar 11, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good.

I think that trunk needs to be updated to fix the read the docs build.

@flying-sheep
Copy link
Copy Markdown
Contributor Author

flying-sheep commented Mar 11, 2025

Huh, never saw that one before!

ERROR: THESE PACKAGES DO NOT MATCH THE HASHES FROM THE REQUIREMENTS FILE. If you have updated the package versions, please update the hashes. Otherwise, examine the package contents carefully; someone may have tampered with them.
    pip from https://files.pythonhosted.org/packages/c9/bc/b7db44f5f39f9d0494071bddae6880eb645970366d0a200022a1a93d57f5/pip-25.0.1-py3-none-any.whl:
        Expected sha256 c46efd13b6aa8279f33f2864459c8ce587ea6a1a59ee20de055868d8f7688f7f
             Got        2f15a3708f631f768bfdc86dbcbfc1b5a31ce7097c5858b011f36a909bb3d4de

@adiroiban
Copy link
Copy Markdown
Member

adiroiban commented Mar 11, 2025 •
edited
Loading

Sorry for the delay... I was quite busy lately.

The code from here is ok... it might be just a Read The Docs issue... I triggered a re-run

Many thanks for your help!

@adiroiban adiroiban merged commit 26b8d30 into twisted:trunk Mar 11, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adiroiban adiroiban adiroiban approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Markdown template skips h2 level when no section exists

2 participants

@flying-sheep @adiroiban