GNU bug report logs - #44479
[PATCH] gnu: Add emacs-csharp-mode.

Previous Next

Full log

Message #8 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: "marco.au.grassi98--- via Guix-patches" via <guix-patches <at> gnu.org>
Cc: marco.au.grassi98 <at> protonmail.com, 44479 <at> debbugs.gnu.org
Subject: Re: [bug#44479] [PATCH] gnu: Add emacs-csharp-mode.
Date: Sat, 07 Nov 2020 10:38:46 +0100

Hello,

"marco.au.grassi98--- via Guix-patches" via <guix-patches <at> 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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.