git-machete icon indicating copy to clipboard operation
git-machete copied to clipboard

Smooth out naming of downstream/upstream; down/up; parent/child

Open PawelLipski opened this issue 2 years ago • 5 comments

upstream is somewhat brittle as it is used by git itself to signify remote tracking branch, see e.g. git show @{upstream}

TBD what to do... preferably stick to parent/child naming (which is NOT used by git itself)

Note that CLI uses git machete go up/down... maybe at least add git machete go parent/child as an alias?

PawelLipski avatar Jul 15 '22 11:07 PawelLipski

@PawelLipski It looks like up/down is used a lot in the code and IMHO it's a good naming convention, so i would stick with it and do not change it to parent/child and only focused on changing upstream to up/down, wdyt?

amalota avatar Jul 19 '22 14:07 amalota

The problem is that upstream is clearly a noun (maybe adverb in collocations like go upstream the river), while up/down can be, depending on the context, an adverb, a preposition, an adjective, a particle, or even a noun (the ups and downs of their relationship). It will be close to impossible to make the manual sound clear when using solely up/down ☹️

PawelLipski avatar Jul 19 '22 14:07 PawelLipski

@PawelLipski I see, but i thought about using up/down with branch only in the context up_branch/down_branch which would be a noun? But parent/child is great, it would just require more work, so parent/child it is?

amalota avatar Jul 19 '22 15:07 amalota

Huh TBH I feel slightly overwhelmed by the scope of this change, I'd defer it until the https://github.com/VirtusLab/git-machete/issues/211 behemoth is done... otherwise we'll gonna drown in changes duplicated b/w docs.py and *.rst files

PawelLipski avatar Jul 19 '22 15:07 PawelLipski

Huh TBH I feel slightly overwhelmed by the scope of this change, I'd defer it until the #211 behemoth is done... otherwise we'll gonna drown in changes duplicated b/w docs.py and *.rst files

Ok

amalota avatar Jul 19 '22 15:07 amalota