Skip to content

make README a markdown document#467

Closed
champignoom wants to merge 1 commit into
yaml:masterfrom
champignoom:patch-1
Closed

make README a markdown document#467
champignoom wants to merge 1 commit into
yaml:masterfrom
champignoom:patch-1

Conversation

@champignoom
Copy link
Copy Markdown

Also mention explicitly the yaml version supported (1.1)

Also mention explicitly the yaml version supported (1.1)
Copy link
Copy Markdown
Member

@ingydotnet ingydotnet 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.

Since this changes a file name, I am moving it to PyYAML 6.0 Release Planning.

I'm planning more file name changes there, and would rather do them at once to avoid potential churn on downstream packaging.

Comment thread README.md
@@ -1,13 +1,13 @@
PyYAML - The next generation YAML parser and emitter for Python.
## PyYAML - The next generation YAML 1.1 parser and emitter for Python
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would prefer:

PyYAML
======

The next generation YAML 1.1 parser and emitter for Python

@bsolomon1124
Copy link
Copy Markdown
Contributor

#327 does this as well. (While #186 converts it to RST.)

@bsolomon1124
Copy link
Copy Markdown
Contributor

Since this changes a file name, I am moving it to PyYAML 6.0 Release Planning.

If that type of backwards compatibility is a concern, could also symlink README to README.md.

@Thom1729
Copy link
Copy Markdown
Contributor

It looks like this was included in 702b176.

@Thom1729 Thom1729 closed this Sep 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants