classification
Title: Convert readme to reStructuredText
Type: enhancement Stage: resolved
Components: Versions: Python 3.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: brett.cannon, louis.taylor, ned.deily, vstinner, zach.ware
Priority: normal Keywords: patch

Created on 2016-07-17 03:04 by louis.taylor, last changed 2017-02-11 05:03 by zach.ware. This issue is now closed.

Files
File name Uploaded Description Edit
readme-to-markdown.patch louis.taylor, 2016-07-17 03:04
readme-to-rst.patch louis.taylor, 2016-07-17 03:29
Pull Requests
URL Status Linked Edit
PR 2 zach.ware, 2017-02-11 05:03
Messages (4)
msg270604 - (view) Author: Louis Taylor (louis.taylor) * Date: 2016-07-17 03:04
Since the move to github is happening, the readme should probably be changed to markdown in order to render nicer on the github web interface. Issue 27476 introduced a .github folder, so it seems that preemptive changes for the migration are okay.
msg270605 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2016-07-17 03:14
Thanks for the patch.  If we do want to use a markup language for the README, we would want to use reStructuredText, the standard markup language for CPython, rather than Markdown, which we currently don't use at all.  Github supports both, doesn't it?  And, for simple documents, like the README, the differences between the two shouldn't be that big.
msg270606 - (view) Author: Louis Taylor (louis.taylor) * Date: 2016-07-17 03:29
Oh, that's a very good point. Patch updated.
msg287593 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2017-02-11 05:03
This has been done in PR2.  Thank you for the patch anyway, Louis, and I'm sorry we didn't wind up using it!
History
Date User Action Args
2017-02-11 05:03:32zach.waresetstatus: open -> closed

versions: + Python 3.7, - Python 3.6
nosy: + vstinner, zach.ware

messages: + msg287593
resolution: fixed
stage: resolved
pull_requests: + pull_request33
2016-07-17 03:39:12louis.taylorsettitle: Convert readme to markdown -> Convert readme to reStructuredText
2016-07-17 03:29:01louis.taylorsetfiles: + readme-to-rst.patch

messages: + msg270606
2016-07-17 03:18:55ned.deilysetnosy: + brett.cannon
2016-07-17 03:14:54ned.deilysetnosy: + ned.deily
messages: + msg270605
2016-07-17 03:04:16louis.taylorcreate