unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eshel Yaron via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Randy Taylor <dev@rjt.dev>
Cc: Evgeni Kolev <evgenysw@gmail.com>, Eli Zaretskii <eliz@gnu.org>,
	60805@debbugs.gnu.org, Theodor Thornhill <theo@thornhill.no>
Subject: bug#60805: [PATCH] Extend go-ts-mode with command to add docstring to function
Date: Sat, 21 Jan 2023 08:48:48 +0200	[thread overview]
Message-ID: <m1tu0kz8kv.fsf@gmail.com> (raw)
In-Reply-To: <IWALdHMjT1i9VNGIhz-cjIQXzKhwsgQAZLwE8nk12_tKn_9JiEg4ce2fXOYE2dFZTX3Yq9uWPcRwj7LgA-lvySdJGbJ47xctUBYTOwPBQhQ=@rjt.dev> (Randy Taylor's message of "Sat, 21 Jan 2023 03:30:40 +0000")


A quick thought from someone interested in using this new command:

IMO the current implementation is a bit too opinionated to be really
useful.  Inserting the function's name at the beginning of the comment
is not always desired because different teams have different conventions
for doc comments, and sometimes you just want to add a nolint
directive[0] which again doesn't start with the function's name.

My suggestion is to add some way for users to customize/extend the
contents of the inserted doc comment.  One option is to have a variable
that'll hold a function responsible for determining the text of the
comment.  This variable can then default to a function that returns the
current Go function's name.

Thanks,
Eshel


[0] https://golangci-lint.run/usage/false-positives/#nolint-directive





  reply	other threads:[~2023-01-21  6:48 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-14  6:45 bug#60805: [PATCH] Extend go-ts-mode with command to add docstring to function Evgeni Kolev
2023-01-14  7:48 ` Eli Zaretskii
2023-01-14 11:43   ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-14 12:24     ` Eli Zaretskii
2023-01-14 13:08       ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-18  6:26         ` Evgeni Kolev
2023-01-18 11:59           ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-20  9:41             ` Evgeni Kolev
2023-01-20 10:14               ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-20 11:39                 ` Evgeni Kolev
2023-01-20 14:56                   ` Evgeni Kolev
2023-01-20 20:39                     ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-21  3:30                       ` Randy Taylor
2023-01-21  6:48                         ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2023-01-21  7:34                           ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-21 14:39                             ` Evgeni Kolev
2023-01-21 20:37                               ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-21 21:26                               ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-18  7:46       ` Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors

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: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=m1tu0kz8kv.fsf@gmail.com \
    --to=bug-gnu-emacs@gnu.org \
    --cc=60805@debbugs.gnu.org \
    --cc=dev@rjt.dev \
    --cc=eliz@gnu.org \
    --cc=evgenysw@gmail.com \
    --cc=me@eshelyaron.com \
    --cc=theo@thornhill.no \
    /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://git.savannah.gnu.org/cgit/emacs.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).