From: Jakub Narebski <jnareb@gmail.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: Denton Liu <liu.denton@gmail.com>,
Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH 08/16] t3310: extract common no_notes_merge_left()
Date: Mon, 30 Dec 2019 21:38:04 +0100 [thread overview]
Message-ID: <86eewl35xv.fsf@gmail.com> (raw)
In-Reply-To: <CAPig+cTaph9Mc1cdL6eNPnTF006YCZ14oLX+xKN9VTVYs7X2_A@mail.gmail.com> (Eric Sunshine's message of "Sat, 28 Dec 2019 02:20:11 -0500")
Eric Sunshine <sunshine@sunshineco.com> writes:
> On Fri, Dec 27, 2019 at 8:48 AM Denton Liu <liu.denton@gmail.com> wrote:
>> diff --git a/t/t3310-notes-merge-manual-resolve.sh b/t/t3310-notes-merge-manual-resolve.sh
>> @@ -32,6 +32,11 @@ verify_notes () {
>> +no_notes_merge_left () {
>> + { ls .git/NOTES_MERGE_* >output || :; } &&
>> + test_must_be_empty output
>> +}
>
> This function name leaves me thinking that it's talking about
> directionality (left vs. right) and gives insufficient clue that it's
> talking about a .git/NOTES_MERGE_* file. A name such as
> assert_no_notes_merge_files() or notes_merge_files_gone() would make
> the intention more obvious.
>
>> - # No .git/NOTES_MERGE_* files left
>> - test_might_fail ls .git/NOTES_MERGE_* >output 2>/dev/null &&
>> - test_must_be_empty output &&
>
> On the other hand, the original in-code comment was not confusing,
> probably because it was obvious it was talking about an actual file,
> due to spelling out .git/NOTES_MERGE_* explicitly and due to actually
> using the literal word "file", plus the code following the comment
> made it very obvious what was happening.
>
> These observations may not be actionable since someone actually
> working on this script will know that it's dealing with
> .git/NOTES_MERGES_*, but as a reviewer not familiar with this
> particular script, reading the patch from top to bottom, I found the
> function name confusing.
The problem with clarity of meaning is enhanced by the fact that during
refactoring the "# No .git/NOTES_MERGE_* files left" comment got lost.
It could have been added in the new function, as first line; or
rephrased as this new function description.
Best,
--
Jakub Narębski
next prev parent reply other threads:[~2019-12-30 20:38 UTC|newest]
Thread overview: 54+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-27 13:47 [PATCH 00/16] t: replace incorrect test_must_fail usage (part 2) Denton Liu
2019-12-27 13:47 ` [PATCH 01/16] t2018: remove trailing space from test description Denton Liu
2019-12-27 13:47 ` [PATCH 02/16] t2018: add space between function name and () Denton Liu
2019-12-27 21:03 ` Eric Sunshine
2019-12-27 13:47 ` [PATCH 03/16] t2018: use test_must_fail for failing git commands Denton Liu
2019-12-28 7:55 ` Eric Sunshine
2019-12-30 20:30 ` Jakub Narebski
2019-12-27 13:47 ` [PATCH 04/16] t2018: teach do_checkout() to accept `!` arg Denton Liu
2019-12-28 8:34 ` Eric Sunshine
2019-12-27 13:47 ` [PATCH 05/16] t2018: don't lose return code of git commands Denton Liu
2019-12-27 21:42 ` Eric Sunshine
2020-01-01 8:48 ` Denton Liu
2020-01-01 9:21 ` Eric Sunshine
2020-01-02 18:26 ` Junio C Hamano
2019-12-27 13:47 ` [PATCH 06/16] t2018: replace "sha" with "oid" Denton Liu
2019-12-27 13:47 ` [PATCH 07/16] t3030: use test_path_is_missing() Denton Liu
2019-12-27 13:47 ` [PATCH 08/16] t3310: extract common no_notes_merge_left() Denton Liu
2019-12-28 7:20 ` Eric Sunshine
2019-12-30 20:38 ` Jakub Narebski [this message]
2019-12-27 13:47 ` [PATCH 09/16] t3415: stop losing return codes of git commands Denton Liu
2019-12-27 13:47 ` [PATCH 10/16] t3415: increase granularity of test_auto_{fixup,squash}() Denton Liu
2019-12-27 13:47 ` [PATCH 11/16] t3419: stop losing return code of git command Denton Liu
2019-12-27 13:47 ` [PATCH 12/16] t3504: don't use `test_must_fail test_cmp` Denton Liu
2019-12-27 20:39 ` Johannes Sixt
2019-12-27 22:48 ` Junio C Hamano
2019-12-27 13:47 ` [PATCH 13/16] t3507: fix indentation Denton Liu
2019-12-27 13:47 ` [PATCH 14/16] t3507: use test_path_is_missing() Denton Liu
2019-12-27 13:47 ` [PATCH 15/16] t4124: only mark git command with test_must_fail Denton Liu
2019-12-27 13:47 ` [PATCH 16/16] t4124: let sed open its own files Denton Liu
2019-12-30 22:52 ` Jakub Narebski
2019-12-30 23:27 ` Junio C Hamano
2020-01-01 8:24 ` Denton Liu
2020-01-01 8:33 ` Eric Sunshine
2020-01-01 8:53 ` Denton Liu
2020-01-07 4:52 ` [PATCH v2 00/16] t: replace incorrect test_must_fail usage (part 2) Denton Liu
2020-01-07 4:52 ` [PATCH v2 01/16] t2018: remove trailing space from test description Denton Liu
2020-01-07 4:52 ` [PATCH v2 02/16] t2018: add space between function name and () Denton Liu
2020-01-07 4:53 ` [PATCH v2 03/16] t2018: improve style of if-statement Denton Liu
2020-01-07 4:53 ` [PATCH v2 04/16] t2018: use test_expect_code for failing git commands Denton Liu
2020-01-12 10:50 ` Eric Sunshine
2020-01-26 20:23 ` [PATCH v3] t2018: be more discerning when checking for expected exit codes Denton Liu
2020-01-07 4:53 ` [PATCH v2 05/16] t2018: teach do_checkout() to accept `!` arg Denton Liu
2020-01-07 4:53 ` [PATCH v2 06/16] t2018: don't lose return code of git commands Denton Liu
2020-01-07 4:53 ` [PATCH v2 07/16] t2018: replace "sha" with "oid" Denton Liu
2020-01-07 4:53 ` [PATCH v2 08/16] t3030: use test_path_is_missing() Denton Liu
2020-01-07 4:53 ` [PATCH v2 09/16] t3310: extract common notes_merge_files_gone() Denton Liu
2020-01-07 4:53 ` [PATCH v2 10/16] t3415: stop losing return codes of git commands Denton Liu
2020-01-07 4:53 ` [PATCH v2 11/16] t3415: increase granularity of test_auto_{fixup,squash}() Denton Liu
2020-01-07 4:53 ` [PATCH v2 12/16] t3419: stop losing return code of git command Denton Liu
2020-01-07 4:53 ` [PATCH v2 13/16] t3504: do check for conflict marker after failed cherry-pick Denton Liu
2020-01-07 4:53 ` [PATCH v2 14/16] t3507: fix indentation Denton Liu
2020-01-07 4:53 ` [PATCH v2 15/16] t3507: use test_path_is_missing() Denton Liu
2020-01-07 4:53 ` [PATCH v2 16/16] t4124: only mark git command with test_must_fail Denton Liu
2020-01-10 21:45 ` [PATCH v2 00/16] t: replace incorrect test_must_fail usage (part 2) Eric Sunshine
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86eewl35xv.fsf@gmail.com \
--to=jnareb@gmail.com \
--cc=git@vger.kernel.org \
--cc=liu.denton@gmail.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).