From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: 44479@debbugs.gnu.org
Cc: marco.au.grassi98@protonmail.com
Subject: [bug#44479] [PATCH] gnu: Add emacs-csharp-mode.
Date: Sat, 07 Nov 2020 10:38:46 +0100 [thread overview]
Message-ID: <87ft5ljyl5.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <Xzx0BymXo4GLF1bWY9tTWhAToWVvv0kZlal4GPX1UtiusHPMY6EirURqP0Fju-BVnmpiAlhCL86zgIspu7dxX5YbXbumJr9_I6GiFKiE2vE=@protonmail.com> (marco au.grassi's message of "Fri, 06 Nov 2020 12:37:55 +0000")
Hello,
"marco.au.grassi98--- via Guix-patches" via <guix-patches@gnu.org>
writes:
> Subject: [PATCH] gnu: Add emacs-csharp-mode.
Thank you. Some comments follow.
>
> + (sha256
> + (base32
> + "0vwkbla2gkfa9dzxfvrvr7hd2z16769iwbycl7k6l701dnwli1fw"))))
Nitpick: please move the string on the same line as `base32'.
> + (build-system emacs-build-system)
> + (home-page
> + "https://github.com/josteink/csharp-mode")
Nitpick: please move the URL on the same line as `home-page'.
> + (synopsis "C# mode derived mode")
This synopsis is a bit cryptic. Could you rephrase it somehow?
> + (description
> + "A C# editing mode for Emacs. Based on cc-mode, v5.30.3 and
> above.
The description ought to consist of "full" sentences.
> + Features include:
> +@itemize
> +@item font-lock and indent of C# syntax including:
> +@itemize
> +@item all c# keywords and major syntax
> +@item attributes that decorate methods, classes, fields, properties
> +@item enum types
> +@item #if/#endif #region/#endregion
> +@item instance initializers
> +@item anonymous functions and methods
> +@item verbatim literal strings (those that begin with @@)
> +@item generics
> +@end itemize
> +@item automagic code-doc generation when you type three slashes.
> +@item intelligent insertion of matched pairs of curly braces.
> +@item imenu indexing of C# source, for easy menu-based navigation.
> +@item compilation-mode support for msbuild, devenv and xbuild.
> +@end itemize\n")
I think it is preferable to avoid nested lists in the description. Also,
according to the manual, "descriptions should take between five and ten
lines". In particular, they do not need to be exhaustive.
For example, it could be something like:
This is a C# editing mode for Emacs, based on CC mode. It handles
syntax coloring, indentation, insertion of matched pairs of curly
braces and documentation generation. In addition, it provides
menu-based navigation using Imenu, and Compilation mode support for
MSBuild, devenv and xbuild.
Could you send an updated patch?
Regards,
--
Nicolas Goaziou
next prev parent reply other threads:[~2020-11-07 9:39 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-06 12:37 [bug#44479] [PATCH] gnu: Add emacs-csharp-mode marco.au.grassi98--- via Guix-patches via
2020-11-07 9:38 ` Nicolas Goaziou [this message]
2020-11-07 10:50 ` marco.au.grassi98--- via Guix-patches via
2020-11-07 13:33 ` Nicolas Goaziou
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://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87ft5ljyl5.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=44479@debbugs.gnu.org \
--cc=marco.au.grassi98@protonmail.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://git.savannah.gnu.org/cgit/guix.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).