From fe255fb8bc87125524207db6115d25a0417a99d5 Mon Sep 17 00:00:00 2001 From: Tobias Geerinckx-Rice Date: Mon, 21 Jun 2021 14:44:47 +0200 Subject: import: egg: Edit egg->guix-package docstring. * guix/import/egg.scm (egg->guix-package): Edit docstring. --- guix/import/egg.scm | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/guix/import/egg.scm b/guix/import/egg.scm index 26f8364732..107894ddcf 100644 --- a/guix/import/egg.scm +++ b/guix/import/egg.scm @@ -1,5 +1,6 @@ ;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2021 Xinglu Chen +;;; Copyright © 2021 Tobias Geerinckx-Rice ;;; ;;; This file is part of GNU Guix. ;;; @@ -173,10 +174,13 @@ return the package metadata in FILE." ;;; (define* (egg->guix-package name #:key (file #f) (source #f)) - "Import CHICKEN egg NAME from and return a record type for the -egg, or #f on failure. FILE is the filepath to the NAME.egg file. SOURCE is -the a ``file-like'' object containing the source code corresonding to the egg. -If SOURCE is not specified, the tarball for the egg will be downloaded. + "Import a CHICKEN egg called NAME from either the given .egg FILE, or from +the latest NAME metadata downloaded from the official repository if FILE is #f. +Return a record or #f on failure. + +SOURCE is a ``file-like'' object containing the source code corresponding to +the egg. If SOURCE is not specified, the latest tarball for egg NAME will be +downloaded. Specifying the SOURCE argument is mainly useful for developing a CHICKEN egg locally. Note that if FILE and SOURCE are specified, recursive import will -- cgit v1.2.3