git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>
To: "Karthik Nayak" <karthik.188@gmail.com>
Cc: git@vger.kernel.org, "Patrick Steinhardt" <ps@pks.im>
Subject: Re: [PATCH] CodingGuidelines: discourage arbitrary suffixes in function names
Date: Mon, 21 Oct 2024 18:51:22 +0200	[thread overview]
Message-ID: <aba3d76c-5234-4875-a1a7-b212bb27b266@app.fastmail.com> (raw)
In-Reply-To: <20241021124145.636561-1-karthik.188@gmail.com>

On Mon, Oct 21, 2024, at 14:41, Karthik Nayak wrote:
> We often name functions with arbitrary suffixes like `_1` as an
> extension of another existing function. This created confusion and
> doesn't provide good clarity into the functions purpose. Let's document
> good function naming etiquette in our CodingGuidelines.
>
> Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
> ---
>
> This is mostly in response to an ongoing thread [1] where I ran into one of
> these functions and it really took me a while to wrap my head around what the
> function does.
>
> [1]:
> https://lore.kernel.org/git/CAOLa=ZREg3xuaT6mbM8+Havn3regZDhK45kGy0+Fw8t56c7Mpg@mail.gmail.com/#R

I was wondering whether it would make sense to use that link in this
document for the context.  But I see that there is only one instance
of that in the current document.

  parent reply	other threads:[~2024-10-21 16:51 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-21 12:41 [PATCH] CodingGuidelines: discourage arbitrary suffixes in function names Karthik Nayak
2024-10-21 12:59 ` Patrick Steinhardt
2024-10-21 20:02   ` Taylor Blau
2024-10-22  8:45     ` karthik nayak
2024-10-22 16:41       ` Taylor Blau
2024-10-23  7:44         ` karthik nayak
2024-10-24  0:50         ` Junio C Hamano
2024-10-24 16:50           ` Taylor Blau
2024-10-22  8:34   ` karthik nayak
2024-10-21 16:51 ` Kristoffer Haugsbakk [this message]
2024-10-22  8:47   ` karthik nayak
2024-10-23  7:57 ` [PATCH v2] " Karthik Nayak
2024-10-23 20:34   ` Taylor Blau
2024-10-23 21:03     ` Karthik Nayak
2024-10-23 23:07     ` Justin Tobler

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aba3d76c-5234-4875-a1a7-b212bb27b266@app.fastmail.com \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=git@vger.kernel.org \
    --cc=karthik.188@gmail.com \
    --cc=ps@pks.im \
    /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.
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 NNTP newsgroup(s).