Convert CHANGELOG and CONTRIBUTING from .rst to .md#277
Merged
Conversation
StanFromIreland
approved these changes
Oct 27, 2025
StanFromIreland
left a comment
StanFromIreland
left a comment
Member
There was a problem hiding this comment.
One minor fix and then LGTM. I could find no other faults, and the GitHub render looks fine too.
StanFromIreland
approved these changes
Oct 27, 2025
Member
|
I think to an extent this is churn, and I do disagree with the premise. I would suggest that a consistency of markup formats within the project matters more than copying-and-pasting into a third party tool (IIRC, GitHub copes with pasting in the rendered HTML, though one has less control). This seems to be a loosing battle though, and README files have been changed to markdown for various reasons elsewhere, so I won't block this if there's desire to push ahead. A |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Markdown is easier to work with, these files are not used by Sphinx, and this will make it easier to copy and paste the generated changelog from GitHub into the file (and avoid mistakes like #276 (comment)).
📚 Documentation preview 📚: https://python-docs-theme-previews--277.org.readthedocs.build/