Closed aneesh-joshi closed 5 years ago
Thanks @aneesh-joshi
@piskvorky any comments?
Good idea! Thanks.
@piskvorky README rst & md really not synced yet. I still think that we should stay only one version (create best .rst version & drop markdown version to avoid "de-sync" state).
I still think…
Did we already discuss this? To me a single version (.rst
) sounds better too, but I don't remember the pros/cons. What were the arguments against it? Why are we keeping both .rst
and .md
?
I don't remember (I'm even not sure if we discussed this)
Maybe @isamaru remember?
Right now I see no pros to maintain both .md
and .rst
, I prefer .md
, but PyPI can render only .rst
, for this reason, single .rst
should be our choice.
@menshikh-iv @piskvorky I've made the mentioned changes. Waiting on your decision on whether to keep .rst or .md
Some questions:
@aneesh-joshi
Does .rst render properly on github?
Yes
How do I autogenerate the .rst? (I can't remember it and couldn't get the exact one through google)
is http://pandoc.org/try/ works OK?
@menshikh-iv
I autogenerated the .rst with
pandoc --from=markdown --to=rst --output=README.rst README.md
but the generated file has a huge diff compared with the original .rst
@aneesh-joshi that's expected: if you looking into commit history, you'll see a huge diff between this 2 files.
Here you need to do some manual work ("join" both to one file).
@menshikh-iv If you see the diff, there is a very large change. Editing it manually will be tedious. Is there a version mismatch or config mismatch in the pandocs? Can i just keep the old version of the rst?
@aneesh-joshi okay, but please raise an issue about syncing .rst
and .md
@menshikh-iv No problem. I fixed it (I think?).
ping @menshikh-iv @piskvorky
Thanks @aneesh-joshi :rocket:
Credit goes to the people on this page. I merely worded their concerns.
Fixes #36 .
CC: @menshikh-iv