Assorted small fixes/improvements to root dir docs by EliahKagan · Pull Request #1663 · gitpython-developers/GitPython (original) (raw)

This contains miscellaneous formatting fixes and minor proofreading in the top-level documentation files, plus making the text in the license section of README.md have links both to external information about the license and to the license file itself. The common theme is that these are changes to "documentation" files in the root of the repository that are individually minor but seem worth making and also don't seem like they would fit well in any other PR about anything else.

Note that the changes to the license file are just removal of excess whitespace (the extra blank line at the end, and spaces appearing at the end of lines). This does not attempt to change what license it used, nor the text of the license!

Some of are changes that are vaguely related to other PRs (whether existing or planned/aspirational). Changing anything related to the license in #1662 might've made that harder to review and might've given the impression to someone casually looking at the history that the license had changed (the opposite of what was really happening). I might open a future PR updating the readthedocs documentation source in doc/source, which may include this kind of proofreading, but it's not obviously better to do those together.