Skip to content

Convert the README to rst#20

Merged
definite merged 3 commits intomasterfrom
unknown repository
May 18, 2015
Merged

Convert the README to rst#20
definite merged 3 commits intomasterfrom
unknown repository

Conversation

@ghost
Copy link
Copy Markdown

@ghost ghost commented May 12, 2015

I found it a little hard to read the README on github, so I converted it to reStructuredText.

I also fixed some spelling and grammar.

@carlosmunoz
Copy link
Copy Markdown
Member

Thanks for the pull request Christopher. This looks good to me.

@definite Could you please review this and merge if you agree?

@seanf
Copy link
Copy Markdown
Contributor

seanf commented May 15, 2015

In the rendered preview, all the command samples ("code") seem to be in <blockquote><code> which is a little odd.

@seanf
Copy link
Copy Markdown
Contributor

seanf commented May 15, 2015

@cjbayliss Perhaps the indented code doesn't need to be surrounded with "``"? (Not sure of my RST, but I'm assuming it's somewhat similar to markdown in this respect.)

@seanf
Copy link
Copy Markdown
Contributor

seanf commented May 15, 2015

I think what I suggested above will work, if the preceding paragraphs end in two colons, like this::

http://sphinx-doc.org/rest.html#source-code

@ghost
Copy link
Copy Markdown
Author

ghost commented May 15, 2015

Yep, that works better, I'll make the change now.

@seanf
Copy link
Copy Markdown
Contributor

seanf commented May 15, 2015

Anyone wanting to see the preview, see here: https://github.com/cjbayliss/zanata-python-client/blob/master/README.rst

@seanf
Copy link
Copy Markdown
Contributor

seanf commented May 15, 2015

@definite Are you happy with the changes?

@seanf
Copy link
Copy Markdown
Contributor

seanf commented May 15, 2015

I generally prefer markdown to RST, but RST probably makes sense for a Python project, and it wouldn't be difficult to convert the formatting from .rst to .md if we need to.

@ghost
Copy link
Copy Markdown
Author

ghost commented May 15, 2015

Yep. I should learn markdown, I just do RST because that is what we use at Cyber IT Solutions. :)

@seanf
Copy link
Copy Markdown
Contributor

seanf commented May 15, 2015

Looks like the .. Note:: rendering is being messed up by this: github/markup#68

I think we'll just have to live with it.

@definite
Copy link
Copy Markdown
Member

The rest looks fine to me.

@ghost
Copy link
Copy Markdown
Author

ghost commented May 18, 2015

I have made that change, I don't know if there are more like that because I don't use Zanata myself. It is probably worth getting someone to got through this README and fix up that sort of stuff. I only converted the README from what it was to rst. :)

definite added a commit that referenced this pull request May 18, 2015
Convert the README to rst

@cjbayliss Thanks!
@definite definite merged commit 2403830 into zanata:master May 18, 2015
@seanf
Copy link
Copy Markdown
Contributor

seanf commented May 18, 2015

Thanks for the contribution, @cjbayliss .

@ghost
Copy link
Copy Markdown
Author

ghost commented May 18, 2015

No problem! :)

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.

3 participants