unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Gabriel Wicki <gabriel@erlikon.ch>
To: 74329@debbugs.gnu.org
Cc: ludo@gnu.org
Subject: [bug#74329] [PATCH v3 4/8] gnu: Replace quotations with texinfo markup in Haskell packages.
Date: Mon, 6 Jan 2025 11:19:05 +0100	[thread overview]
Message-ID: <87cyh0qlct.fsf@erlikon.ch> (raw)
In-Reply-To: <hg3zpgjejjfuex7wmzr2ylpe3zbck7bldkpubw5li6y3r7tnas@nzckb4tbxcsy>

* gnu/packages/haskell-check.scm (ghc-tasty-silver): Fix description.
* gnu/packages/haskell-xyz.scm (ghc-hsyaml, ghc-regex-tdfa, ghc-rio,
ghc-unsafe, ghc-mysql, ghc-witherable, ghc-random-bytestring, ghc-boring): Fix
description.

Change-Id: I63b9de3f7a3f360e84067898819cfcbc1b1b6fd4
---
 gnu/packages/haskell-check.scm |  2 +-
 gnu/packages/haskell-xyz.scm   | 64 +++++++++++++++++++---------------
 2 files changed, 37 insertions(+), 29 deletions(-)

diff --git a/gnu/packages/haskell-check.scm b/gnu/packages/haskell-check.scm
index e668706959..44da569bfa 100644
--- a/gnu/packages/haskell-check.scm
+++ b/gnu/packages/haskell-check.scm
@@ -1155,7 +1155,7 @@ (define-public ghc-tasty-silver
      "This package provides a fancy test runner and support for @dfn{golden
 testing}.  A golden test is an IO action that writes its result to a file.  To
 pass the test, this output file should be identical to the corresponding
-``golden'' file, which contains the correct result for the test.  The test
+@emph{golden} file, which contains the correct result for the test.  The test
 runner allows filtering tests using regexes, and to interactively inspect the
 result of golden tests.")
     (license license:expat)))
diff --git a/gnu/packages/haskell-xyz.scm b/gnu/packages/haskell-xyz.scm
index 0a58ee4d24..aa4c4b15f0 100644
--- a/gnu/packages/haskell-xyz.scm
+++ b/gnu/packages/haskell-xyz.scm
@@ -5792,7 +5792,7 @@ (define-public ghc-hsyaml
 representation (including support for cyclic YAML data structures).
 
 @item Support for the standard (untyped) @emph{Failsafe}, (strict)
-@emph{JSON}, and (flexible) @emph{Core} ``schemas'' providing implicit
+@emph{JSON}, and (flexible) @emph{Core} @code{schemas} providing implicit
 typing rules as defined in the YAML 1.2 specification (including support
 for user-defined custom schemas).
 
@@ -10303,9 +10303,9 @@ (define-public ghc-regex-tdfa
     (home-page "https://wiki.haskell.org/Regular_expressions")
     (synopsis "POSIX extended regular expressions in Haskell")
     (description
-     "Regex-tdfa is a pure Haskell regular expression library implementing POSIX
-extended regular expressions.  It is a \"tagged\" DFA regex engine. It is
-inspired by libtre.")
+     "Regex-tdfa is a pure Haskell regular expression library implementing
+POSIX extended regular expressions.  It is a @emph{tagged} DFA regex engine.
+It is inspired by libtre.")
     (license license:bsd-3)))
 
 (define-public ghc-repline
@@ -10506,7 +10506,7 @@ (define-public ghc-rio
      "This package works as a prelude replacement for Haskell,
 providing more functionality and types out of the box than the standard
 prelude (such as common data types like @code{ByteString} and
-@code{Text}), as well as removing common ``gotchas'', like partial
+@code{Text}), as well as removing common @emph{gotchas}, like partial
 functions and lazy I/O.  The guiding principle here is:
 @itemize
 @item If something is safe to use in general and has no expected naming
@@ -13695,7 +13695,7 @@ (define-public ghc-unsafe
     (home-page "https://hackage.haskell.org/package/unsafe")
     (synopsis "Unified interface to unsafe functions")
     (description "Safe Haskell introduced the notion of safe and unsafe
-modules.  In order to make as many as possible modules ``safe'', the
+modules.  In order to make as many as possible modules @emph{safe}, the
 well-known unsafe functions were moved to distinguished modules.  This
 makes it hard to write packages that work with both old and new versions
 of GHC.  This package provides a single module System.Unsafe that
@@ -15391,7 +15391,7 @@ (define-public ghc-mysql
 most of the MySQL client API.  The major departure from the C API is that in
 Haskell, resource management is mostly automatic and safe.
 
-This library deliberately avoids the question of providing a ``good'' API.
+This library deliberately avoids the question of providing a @emph{good} API.
 Its purpose is to serve as a base upon which higher-level libraries can be
 built.")
     (license license:bsd-3)))
@@ -16153,8 +16153,8 @@ (define-public ghc-witherable
     (home-page "https://github.com/fumieval/witherable")
     (synopsis "Filterable traversable")
     (description
-     "This package provides a stronger variant of `traverse` which can remove elements
-and generalised mapMaybe, catMaybes, filter")
+     "This package provides a stronger variant of @code{traverse} which can
+remove elements and generalised mapMaybe, catMaybes, filter")
     (license license:bsd-3)))
 
 (define-public ghc-hspec-discover
@@ -16263,22 +16263,29 @@ (define-public ghc-random-bytestring
     (home-page "https://www.github.com/larskuhtz/random-bytestring")
     (synopsis "Efficient generation of random bytestrings")
     (description
-     "__This package is deprecated__.  Please, use genByteString from the [random
-package (version >=1.2)](https://hackage.haskell.org/package/random) instead. .
-Efficient generation of random bytestrings.  The implementation populates
-uninitialized memory with uniformily distributed random 64 bit words (and 8 bit
-words for remaining bytes at the end of the bytestring). .  Random words are
-generated using the PRNG from the
-[mwc-random](https://hackage.haskell.org/package/mwc-random) package or the
-[pcg-random](https://hackage.haskell.org/package/pcg-random) package.  It is
-also possible to use a custom PRNG by providing an instance for the RandomWords
-type class and using the function generate from the module
-\"Data.ByteString.Random.Internal\". .  The generated byte strings are suitable
-for statistical applications.  They are /not/ suitable for cryptographic
-applications. .
-![benchmarks](https://hackage.haskell.org/package/random-bytestring-0.1.3.2/src/benchmarks.png)
-. ![detailed
-benchmarks](https://hackage.haskell.org/package/random-bytestring-0.1.3.2/src/benchmarks-details.png)")
+     "@emph{This package is deprecated}.  Please, use genByteString from the
+@url{https://hackage.haskell.org/package/random,random package (version
+>=1.2)]} instead.  Efficient generation of random bytestrings.  The
+implementation populates uninitialized memory with uniformily distributed
+random 64 bit words (and 8 bit words for remaining bytes at the end of the
+bytestring).  Random words are generated using the PRNG from the
+@url{https://hackage.haskell.org/package/mwc-random, mwc-random} package or
+the @url{https://hackage.haskell.org/package/pcg-random, pcg-random} package.
+It is also possible to use a custom PRNG by providing an instance for the
+RandomWords type class and using the function generate from the module
+@code{Data.ByteString.Random.Internal}.  The generated byte strings are
+suitable for statistical applications.  They are @emph{not} suitable for
+cryptographic applications.
+@itemize
+
+@item
+@url{https://hackage.haskell.org/package/random-bytestring-0.1.3.2/src/benchmarks.png,
+benchmarks}
+
+@item
+@url{https://hackage.haskell.org/package/random-bytestring-0.1.3.2/src/benchmarks-details.png,
+detailed benchmarks}
+@end itemize")
     (license license:expat)))
 
 (define-public ghc-base64
@@ -16868,9 +16875,10 @@ (define-public ghc-boring
     (home-page "https://github.com/phadej/boring")
     (synopsis "Boring and Absurd types")
     (description
-     "* @@Boring@@ types are isomorphic to @@()@@. . * @@Absurd@@ types are isomorphic
-to @@Void@@. .  See [What does () mean in Haskell -answer by Conor
-McBride](https://stackoverflow.com/questions/33112439/what-does-mean-in-haskell/33115522#33115522)")
+     "@itemize
+@item @code{Boring} types are isomorphic to @code{()}.
+@item @code{Absurd} types are isomorphic to @code{Void}.
+@end itemize")
     (license license:bsd-3)))
 
 (define-public ghc-some
-- 
2.46.0





  parent reply	other threads:[~2025-01-06 10:38 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-12 20:36 [bug#74329] [PATCH 0/2] Extensively lint descriptions and synopses Gabriel Wicki
     [not found] ` <handler.74329.B.173144383113227.ack@debbugs.gnu.org>
2024-11-12 20:41   ` [bug#74329] [PATCH 1/2] gnu: Lint synopses Gabriel Wicki
2024-12-11  7:08     ` Vagrant Cascadian
2024-12-11 11:37       ` Gabriel Wicki
2024-11-12 20:42   ` [bug#74329] [PATCH 2/2] gnu: Lint descriptions Gabriel Wicki
2024-12-29 10:30     ` Ludovic Courtès
2024-11-21 22:28 ` [bug#74329] resend? Gabriel Wicki
2024-11-21 22:30 ` [bug#74329] [PATCH 1/2] gnu: Lint synopses Gabriel Wicki
2024-11-21 22:31 ` [bug#74329] [PATCH 2/2] gnu: Lint descriptions Gabriel Wicki
2024-12-10 23:08 ` [bug#74329] [PATCH 0/2] Extensively lint descriptions and synopses Vagrant Cascadian
2025-01-04 23:39 ` [bug#74329] [PATCH v2 1/6] gnu: Fix whitespace issues in descriptions Gabriel Wicki
2025-01-05 20:56   ` Vagrant Cascadian
2025-01-05  0:36 ` [bug#74329] [PATCH v2 3/6] gnu: Fix various style " Gabriel Wicki
2025-01-05 20:45   ` Vagrant Cascadian
2025-01-05  0:36 ` [bug#74329] [PATCH v2 2/6] gnu: Remove quotation marks " Gabriel Wicki
2025-01-05  1:01 ` [bug#74329] [PATCH v2 3/6] gnu: Fix various style issues " Gabriel Wicki
2025-01-05  1:04 ` [bug#74329] [PATCH v2 4/6] gnu: Fix texinfo markup " Gabriel Wicki
2025-01-05  1:49 ` [bug#74329] [PATCH v2 5/6] gnu: Fix description beginnings Gabriel Wicki
2025-01-05  1:54 ` [bug#74329] [PATCH v2 6/6] gnu: Fix various synopses Gabriel Wicki
2025-01-05 20:44   ` Vagrant Cascadian
2025-01-05  1:58 ` [bug#74329] [PATCH v2 0/6] Lint descriptions and synopses Gabriel Wicki
2025-01-05 21:09   ` Vagrant Cascadian
2025-01-05 21:18 ` [bug#74329] [PATCH 02/10] gnu: Fix whitespace issues in go package descriptions Gabriel Wicki
2025-01-05 21:20 ` [bug#74329] [PATCH 03/10] gnu: Fix whitespace issues in Haskell " Gabriel Wicki
2025-01-05 21:21 ` [bug#74329] [PATCH 04/10] gnu: Fix whitespace issues in Rust " Gabriel Wicki
2025-01-05 21:22 ` [bug#74329] [PATCH 05/10] gnu: Fix whitespace issues in Linux " Gabriel Wicki
2025-01-05 21:22 ` [bug#74329] [PATCH 06/10] gnu: Fix whitespace issues in Python " Gabriel Wicki
2025-01-05 21:23 ` [bug#74329] [PATCH 07/10] gnu: Fix whitespace issues in R " Gabriel Wicki
2025-01-05 21:24 ` [bug#74329] [PATCH 08/10] gnu: Fix whitespace issues in Emacs " Gabriel Wicki
2025-01-05 21:24 ` [bug#74329] [PATCH 09/10] gnu: Fix whitespace issues in Lisp " Gabriel Wicki
2025-01-05 21:24 ` [bug#74329] [PATCH 10/10] gnu: Fix whitespace issues in Tex " Gabriel Wicki
2025-01-05 21:29 ` [bug#74329] [PATCH 01/10] gnu: Fix whitespace issues in various descriptions Gabriel Wicki
2025-01-05 21:33 ` [bug#74329] [PATCH 00/10] The long patch is now split up into 10 smaller patches Gabriel Wicki
2025-01-05 23:50   ` Vagrant Cascadian
2025-01-06 10:12 ` [bug#74329] [PATCH v3 1/8] gnu: Replace quotations with texinfo markup in Tex packages Gabriel Wicki
2025-01-06 10:15 ` [bug#74329] [PATCH v3 2/8] gnu: Replace quotations with texinfo markup in Perl packages Gabriel Wicki
2025-01-06 10:17 ` [bug#74329] [PATCH v3 3/8] gnu: Replace quotations with texinfo markup in Java packages Gabriel Wicki
2025-01-06 10:19 ` Gabriel Wicki [this message]
2025-01-06 10:19 ` [bug#74329] [PATCH v3 5/8] gnu: Replace quotations with texinfo markup in Emacs packages Gabriel Wicki
2025-01-06 10:20 ` [bug#74329] [PATCH v3 6/8] gnu: Replace quotations with texinfo markup in Rust packages Gabriel Wicki
2025-01-06 10:21 ` [bug#74329] [PATCH v3 7/8] gnu: Replace quotations with texinfo markup in R packages Gabriel Wicki
2025-01-06 10:22 ` [bug#74329] [PATCH v3 8/8] gnu: Replace quotations with texinfo markup in various packages Gabriel Wicki
2025-01-06 10:28 ` [bug#74329] [PATCH v3 0/8] Replace quotation marks with adequate texinfo markup Gabriel Wicki

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=87cyh0qlct.fsf@erlikon.ch \
    --to=gabriel@erlikon.ch \
    --cc=74329@debbugs.gnu.org \
    --cc=ludo@gnu.org \
    /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).