Title: Clarify license and make module top comments more consistent by EliahKagan · Pull Request #1730 · gitpython-developers/GitPython · GitHub
Open Graph Title: Clarify license and make module top comments more consistent by EliahKagan · Pull Request #1730 · gitpython-developers/GitPython
X Title: Clarify license and make module top comments more consistent by EliahKagan · Pull Request #1730 · gitpython-developers/GitPython
Description: While working on #1725, I noticed that comments at the top of modules might be made clearer and more consistent, but judged that such a change would be easier to review if proposed in a separate PR. So I've proposed those changes here instead, and included closely logically related changes as well. This does not attempt to change the terms under which the project is licensed, nor does it change the license file. However, the changes here do include a change to some of the metadata used to specify the license, which will result in some license information being displayed differently on PyPI. I believe this change is for the better, of course, or I wouldn't be proposing it--it more specifically identifies the exact BSD license this project uses, the 3-Clause BSD License--but I recognize that this may merit special scrutiny in review. Changes are presented in more detail in the three commit messages. In brief summary (the first commit covering the first three of these points): Filenames, which were given only in some modules, are omitted from all top comments, because GitPython contains many modules that have the same filename as others of its modules, so the filenames are in practice less clarifying while working on the code than they would be in some other projects. Top comments are now present in all modules one might expect or want them to be, indicating that the module is part of GitPython, and what the license is. Both existing and new license information in top comments is made more specific, specifying the 3-Clause BSD License rather than using the ambiguous phrase "BSD License". This change should not be confused with the change in #1662, which updated links that had come to point to the wrong license. This doesn't modify any URLs, instead modifying the text near them. The README is updated to give both names, emphasizing the more modern license name. setup.py is modified to pass "BSD-3-Clause" for the license= keyword argument to setup, instead of "BSD". The license-related classifier is not changed, since no more specific classifier is available. (The commit message has significant further details about this.)
Open Graph Description: While working on #1725, I noticed that comments at the top of modules might be made clearer and more consistent, but judged that such a change would be easier to review if proposed in a separate PR...
X Description: While working on #1725, I noticed that comments at the top of modules might be made clearer and more consistent, but judged that such a change would be easier to review if proposed in a separate PR...
Opengraph URL: https://github.com/gitpython-developers/GitPython/pull/1730
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:4b10c8cf-94b2-a912-9339-3e7ca34c4666 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | AED8:D7EFC:5F23BB:84EFE8:6968CCA9 |
| html-safe-nonce | e26e8e69354d44664aaf0b44e6d33bdd9c708db7ae84268986a3dc063b9c555c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBRUQ4OkQ3RUZDOjVGMjNCQjo4NEVGRTg6Njk2OENDQTkiLCJ2aXNpdG9yX2lkIjoiMzU0NDYwMDc2NDE0NDQ3MTIwOSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | e418c63b49a084fad98b20a849dc4c9c28dea800c017979ddd1f98860a76b385 |
| hovercard-subject-tag | pull_request:1586549834 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/gitpython-developers/GitPython/pull/1730/files |
| twitter:image | https://avatars.githubusercontent.com/u/1771172?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1771172?s=400&v=4 |
| og:image:alt | While working on #1725, I noticed that comments at the top of modules might be made clearer and more consistent, but judged that such a change would be easier to review if proposed in a separate PR... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | af2d7af0cc84117fa10bf36808605ef68a335c9d8a804b9cdac55f8d77230b00 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/gitpython-developers/GitPython git https://github.com/gitpython-developers/GitPython.git |
| octolytics-dimension-user_id | 503709 |
| octolytics-dimension-user_login | gitpython-developers |
| octolytics-dimension-repository_id | 1126087 |
| octolytics-dimension-repository_nwo | gitpython-developers/GitPython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1126087 |
| octolytics-dimension-repository_network_root_nwo | gitpython-developers/GitPython |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | cc844ab6ee0198cc2e2c142dcb8a5c2a61d48743 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width