GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | ||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | ||||||||||||||||||
GeezerVison is showing github.com — Submodule.remove `module` parameter doc is unclear or incomplete · Issue #1712 · gitpython-developers/GitPython Closed Labels DescriptionThe docstring for GitPython/git/objects/submodule/base.py Lines 951 to 959 in 6f765a2
A 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. The current phrasing appears to be the effect of an unsuccessful or incomplete attempt, in 8e0e315, to fix a similar misphrasing. Compared to the original wording in 3d061a1, the change was: :param module: If True, the module 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, if you have modifications in the
working tree, or untracked files,
+ is ahead of its tracking branch, if you have modifications in the
In case the removal of the repository fails for these reasons, the
submodule status will not have been altered.
If this submodule has child-modules on its own, these will be deletedSo the original wording also trailed off in mid-sentence, but differently, with "working tree, or untracked files,". I can guess the intended meaning:
If that revision is correct, it could be clarified by a small amount of further rewording:
However, I am not sure enough that this is the intended meaning to have put either of those changes in a PR at this time. Activity
MetadataMetadataAssigneesLabelsTypeProjectsMilestoneRelationshipsDevelopmentIssue actions | ||||||||||||||||||
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |