all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Federico Beffa <beffa@ieee.org>
To: "Ludovic Courtès" <ludo@gnu.org>
Cc: Guix-devel <guix-devel@gnu.org>
Subject: Re: [PATCH 02/24] gnu: Add ghc-paths.
Date: Wed, 8 Apr 2015 13:44:46 +0200	[thread overview]
Message-ID: <CAKrPhPNCQ-=AWOgkJqoSdMVYdkpqE84U84tmsbe4f=7q4bcaOA@mail.gmail.com> (raw)
In-Reply-To: <878ue359rz.fsf@gnu.org>

On Wed, Apr 8, 2015 at 10:01 AM, Ludovic Courtès <ludo@gnu.org> wrote:
>> +    (synopsis
>> +     "Knowledge of GHC's installation directories")
>> +    (description
>> +     "Knowledge of GHC's installation directories.")
>
> Please expound a little bit.  Otherwise OK.

Thanks for reviewing all of these!

The problem with this and some other libraries is that the library
doesn't have an official home-page (apart from a source repository
which doesn't include anything other than the source). The description
is taken one-to-one from the Cabal file and I don't really know how I
can expand the description.

The Cabal file of some other libraries like, e.g., ghc-network, give
an, IMO, too detailed description (sometimes even with a code
snippet):

...
description:
  This package provides a low-level networking interface.
  .
  In network-2.6 the @Network.URI@ module was split off into its own
  package, network-uri-2.6. If you're using the @Network.URI@ module
  you can automatically get it from the right package by adding this
  to your .cabal file:
  .
  > flag network-uri
  >   description: Get Network.URI from the network-uri package
  >   default: True
  >
  > library
  >   -- ...
  >   if flag(network-uri)
  >     build-depends: network-uri >= 2.6, network >= 2.6
  >   else
  >     build-depends: network-uri < 2.6, network < 2.6
  .
  That is, get the module from either network < 2.6 or from
  network-uri >= 2.6.
...

... and they also only have a source repository with no high level
information. For this reason I did cut the description to the,
sometimes very short, high level piece.

I hope it's fine to keep the concise description for these.

Regards,
Fede

  reply	other threads:[~2015-04-08 11:44 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-06 16:38 [PATCH 02/24] gnu: Add ghc-paths Federico Beffa
2015-04-08  8:01 ` Ludovic Courtès
2015-04-08 11:44   ` Federico Beffa [this message]
2015-04-08 12:10     ` Ludovic Courtès

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='CAKrPhPNCQ-=AWOgkJqoSdMVYdkpqE84U84tmsbe4f=7q4bcaOA@mail.gmail.com' \
    --to=beffa@ieee.org \
    --cc=guix-devel@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 external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.