René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Submodule.remove `module` parameter doc is unclear or incomplete","articleBody":"The docstring for [`Submodule.remove`](https://github.com/gitpython-developers/GitPython/blob/main/git/objects/submodule/base.py#L941) documents the `module` parameter this way:\r\n\r\nhttps://github.com/gitpython-developers/GitPython/blob/6f765a2028e45a14853bf06801104cc6d22e053e/git/objects/submodule/base.py#L951-L959\r\n\r\nA sentence trails off in \"if you have modifications in the\" and it appears material is missing. This should be revised, but it is is unclear exactly what the intended meaning is, so I don't know for sure how to fix it.\r\n\r\nThe current phrasing appears to be the effect of an unsuccessful or incomplete [attempt](https://github.com/gitpython-developers/GitPython/commit/8e0e315a371cdfc80993a1532f938d56ed7acee4#diff-0d77f7389366948adb9b48c092150ac5c03033de1d89250748ae9add1e548eb5R512-R519), in 8e0e315, to fix a similar misphrasing. Compared to the [original wording](https://github.com/gitpython-developers/GitPython/commit/3d061a1a506b71234f783628ba54a7bdf79bbce9#diff-b783f55c358d34650a259d030b6ed9b67b611d205ed239027c861cad71b67d93R337-R345) in 3d061a1, the change was:\r\n\r\n```diff\r\n         :param module: If True, the module we point to will be deleted \r\n             as well. If the module is currently on a commit which is not part \r\n             of any branch in the remote, if the currently checked out branch \r\n-            is ahead of its tracking branch,  if you have modifications in the\r\n             working tree, or untracked files,\r\n+            is ahead of its tracking branch,  if you have modifications in the\r\n             In case the removal of the repository fails for these reasons, the \r\n             submodule status will not have been altered.\r\n             If this submodule has child-modules on its own, these will be deleted\r\n```\r\n\r\nSo the original wording also trailed off in mid-sentence, but differently, with \"working tree, or untracked files,\".\r\n\r\nI can *guess* the intended meaning:\r\n\r\n\u003e If True, the module checkout we point to will be deleted as well. If the module is currently on a commit which is not part of any branch in the remote, if the currently checked out branch is ahead of its tracking branch, or if there are modifications to the working tree or untracked files, then the removal will fail.\r\n\r\nIf that revision is correct, it could be clarified by a small amount of further rewording:\r\n\r\n\u003e If True, the checked out module we point to will be deleted as well. If that module is currently on a commit outside any branch in the remote, or if it is ahead of its tracking branch, or if there are modified or untracked files in its working tree, then the removal will fail.\r\n\r\nHowever, I am not sure enough that this is the intended meaning to have put either of those changes in a PR at this time.","author":{"url":"https://github.com/EliahKagan","@type":"Person","name":"EliahKagan"},"datePublished":"2023-10-17T23:17:14.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/1712/GitPython/issues/1712"}