Pull requests

#2 Merged

Various stylistic improvements

  1. Ryan Macy

I attempted to make the docs more readable by adjusting to consistent spacing and styling. Fixed a few typos, and made the sentences flow better (at least to me).

UPDATE: I believe I have a much more consistent styling this go around. It should be following the Python documentation conventions.

  • Learn about pull requests

Comments (3)

  1. Vinay Sajip repo owner

    Generally the changes look OK and I will pull soon, but I would make the following comments:

    1. I believe two empty lines are normally expected before a heading, which is why I had all those empty lines which you've removed. I'm not sure if I had applied that consistently, though.
    2. You seem not to like semicolons and commas as much as I do. Though in some cases it works either way, there are other cases where I would prefer to keep them as they are - particularly in longer sentences I believe the commas should remain (as if reading the text out loud, there would be a natural pause at the point I had the comma) whereas in other places, the semicolon seems more appropriate than the comma.

    I don't want to appear too picky about these things, but writing style is quite a personal thing - anyway, don't worry about making any more changes, I'll accept this request and adjust in any areas where I think it's warranted. Thanks for the help!

  2. Ryan Macy author

    Great! I'll make sure to be mindful of #1, I'm still learning the documentation conventions for Python :) On #2 like I mentioned, I changed things in a way that flowed well for me, I believe writing is much like speaking in that individuals communicate differently. I'd like to keep to your style of writing and I suspect that my ability to do that will improve as I contribute to the project.

    Thanks for accepting the PR, I hope it helps!

  3. Vinay Sajip repo owner

    I've now merged the changes - I had to make certain additional edits. For example, the sections after currentmodule directives are not meant to be indented. Most of the changes have been taken, though I have kept semicolons in a number of places where commas were inappropriate.