[bug#45542] import: pypi: Clearify docstring of parse-requires.txt

[bug#45542] import: pypi: Clearify docstring of parse-requires.txt

[Rovanion Luckey]

[-- Attachment #1.1: Type: text/plain, Size: 217 bytes --]

When mucking about the codebase trying to figure out if it would be
possible to automatically import a Python project using Guix preexisting
functions I found a docstring I thought could be more explicit than it was.

[-- Attachment #1.2: Type: text/html, Size: 242 bytes --]

[-- Attachment #2: 0001-import-pypi-Clearify-docstring-on-parse-requires.txt.patch --]
[-- Type: text/x-patch, Size: 933 bytes --]

From 338ac21c68e757d94b8375cb42345a82488f1708 Mon Sep 17 00:00:00 2001
From: Rovanion Luckey <rovanion.luckey@gmail.com>
Date: Thu, 26 Nov 2020 20:59:19 +0100
Subject: [PATCH 1/2] import: pypi: Clearify docstring of parse-requires.txt

---
 guix/import/pypi.scm | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/guix/import/pypi.scm b/guix/import/pypi.scm
index bf4dc50138..6731d50891 100644
--- a/guix/import/pypi.scm
+++ b/guix/import/pypi.scm
@@ -229,8 +229,8 @@ the input field."
        '("test" "dev")))

 (define (parse-requires.txt requires.txt)
-  "Given REQUIRES.TXT, a Setuptools requires.txt file, return a list of lists
-of requirements.
+  "Given REQUIRES.TXT, a path to a Setuptools requires.txt file, return a list
+of lists of requirements.

 The first list contains the required dependencies while the second the
 optional test dependencies.  Note that currently, optional, non-test
--
2.29.2

bug#45542: import: pypi: Clearify docstring of parse-requires.txt

[Leo Famulari]

On Tue, Dec 29, 2020 at 11:54:11PM +0100, Rovanion Luckey wrote:
> When mucking about the codebase trying to figure out if it would be
> possible to automatically import a Python project using Guix preexisting
> functions I found a docstring I thought could be more explicit than it was.

> From 338ac21c68e757d94b8375cb42345a82488f1708 Mon Sep 17 00:00:00 2001
> From: Rovanion Luckey <rovanion.luckey@gmail.com>
> Date: Thu, 26 Nov 2020 20:59:19 +0100
> Subject: [PATCH 1/2] import: pypi: Clearify docstring of parse-requires.txt

Thanks! Pushed as 9215f35b78e40d31ebece54fb7938aa321ec9130