Skip to content

Change README format to Markdown#327

Closed
timhoffm wants to merge 1 commit intoyaml:masterfrom
timhoffm:readme-md
Closed

Change README format to Markdown#327
timhoffm wants to merge 1 commit intoyaml:masterfrom
timhoffm:readme-md

Conversation

@timhoffm
Copy link
Copy Markdown
Contributor

@timhoffm timhoffm commented Aug 5, 2019

The main motivation is to make it more readable on the github home page https://github.com/yaml/pyyaml.

@mattseymour
Copy link
Copy Markdown

Kinda makes sense 👍

Copy link
Copy Markdown
Contributor

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Looks good, preview it here:

https://github.com/timhoffm/pyyaml/blob/73721374d10f1998580452168b800c1d76f27f4c/README.md

Either here or in another PR, the Markdown could be included as the long_description on PyPI. See:

https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi/

@anishathalye
Copy link
Copy Markdown
Contributor

Not sure if this PR is the best place for this, or if it should go in a separate PR. I noticed that the README doesn't have a mention of PyPI / pip install. This might be good to include, because most users probably install using that rather than python setup.py install after cloning the repo.

This seems especially important because pip install yaml, which some users might guess, will do the wrong thing, it's pip install pyyaml.

@timhoffm
Copy link
Copy Markdown
Contributor Author

It's sad to see this stall despite user approval and activity in the repo. 😢

I would be willing to rebase if there is interest in moving this in. But I don't want to invest time rebasing just to have this lay around and stall again. Please notify if you want to move this forward. If there is no interest, you may as well close.

@perlpunk
Copy link
Copy Markdown
Member

sorry, there are just so many issues and PRs, and I also have other projects.
I would say yes, please rebase.
Have to check with Ingy though

@timhoffm
Copy link
Copy Markdown
Contributor Author

Thanks for the feedback. Rebased.

@Thom1729
Copy link
Copy Markdown
Contributor

The readme was converted in 702b176.

@Thom1729 Thom1729 closed this Sep 22, 2021
@timhoffm timhoffm deleted the readme-md branch September 22, 2021 19:06
stuhood pushed a commit to pantsbuild/pants that referenced this pull request Oct 20, 2021
PyYAML 6:
```
6.0 (2021-10-13)

* yaml/pyyaml#327 -- Change README format to Markdown
* yaml/pyyaml#483 -- Add a test for YAML 1.1 types
* yaml/pyyaml#497 -- fix float resolver to ignore `.` and `._`
* yaml/pyyaml#550 -- drop Python 2.7
* yaml/pyyaml#553 -- Fix spelling of “hexadecimal”
* yaml/pyyaml#556 -- fix representation of Enum subclasses
* yaml/pyyaml#557 -- fix libyaml extension compiler warnings
* yaml/pyyaml#560 -- fix ResourceWarning on leaked file descriptors
* yaml/pyyaml#561 -- always require `Loader` arg to `yaml.load()`
* yaml/pyyaml#564 -- remove remaining direct distutils usage
```
halstead pushed a commit to openembedded/openembedded-core that referenced this pull request Oct 23, 2021
Now uses "vendored" distutils from setuptools by default
rather than from Python stdlib.

Changes
=======

* yaml/pyyaml#327
  -- Change README format to Markdown
* yaml/pyyaml#483
  -- Add a test for YAML 1.1 types
* yaml/pyyaml#497
  -- fix float resolver to ignore `.` and `._`
* yaml/pyyaml#550
  -- drop Python 2.7
* yaml/pyyaml#553
  -- Fix spelling of “hexadecimal”
* yaml/pyyaml#556
  -- fix representation of Enum subclasses
* yaml/pyyaml#557
  -- fix libyaml extension compiler warnings
* yaml/pyyaml#560
  -- fix ResourceWarning on leaked file descriptors
* yaml/pyyaml#561
  -- always require `Loader` arg to `yaml.load()`
* yaml/pyyaml#564
  -- remove remaining direct distutils usage

Signed-off-by: Tim Orling <timothy.t.orling@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
seambot pushed a commit to seamapi/poky that referenced this pull request Oct 23, 2021
Now uses "vendored" distutils from setuptools by default
rather than from Python stdlib.

Changes
=======

* yaml/pyyaml#327
  -- Change README format to Markdown
* yaml/pyyaml#483
  -- Add a test for YAML 1.1 types
* yaml/pyyaml#497
  -- fix float resolver to ignore `.` and `._`
* yaml/pyyaml#550
  -- drop Python 2.7
* yaml/pyyaml#553
  -- Fix spelling of “hexadecimal”
* yaml/pyyaml#556
  -- fix representation of Enum subclasses
* yaml/pyyaml#557
  -- fix libyaml extension compiler warnings
* yaml/pyyaml#560
  -- fix ResourceWarning on leaked file descriptors
* yaml/pyyaml#561
  -- always require `Loader` arg to `yaml.load()`
* yaml/pyyaml#564
  -- remove remaining direct distutils usage

(From OE-Core rev: 2abc7a612a71b3594f3183fbb824a708269ae694)

Signed-off-by: Tim Orling <timothy.t.orling@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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.

8 participants