09/72: gnu-maintenance: Document nested procedures in 'import-html-release'.

[guix-commits]

apteryx pushed a commit to branch qt-updates
in repository guix.

commit 13bb74db81862803c9e2ae982c117de71acd2611
Author: Maxim Cournoyer <maxim.cournoyer@gmail.com>
AuthorDate: Thu Aug 10 12:06:05 2023 -0400

    gnu-maintenance: Document nested procedures in 'import-html-release'.
    
    * guix/gnu-maintenance.scm (import-html-release): Add docstring to the
    'file->signature/guess' and 'url->release' nested procedures.
---
 guix/gnu-maintenance.scm | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/guix/gnu-maintenance.scm b/guix/gnu-maintenance.scm
index 13d6c1c7f2..9bab8e9e5f 100644
--- a/guix/gnu-maintenance.scm
+++ b/guix/gnu-maintenance.scm
@@ -514,6 +514,7 @@ are unavailable."
                   (string-append base-url directory "/")))
          (links (url->links url)))
     (define (file->signature/guess url)
+      "Return the first link that matches a signature extension, else #f."
       (let ((base (basename url)))
         (any (lambda (link)
                (any (lambda (extension)
@@ -524,6 +525,8 @@ are unavailable."
              links)))
 
     (define (url->release url)
+      "Return an <upstream-source> object if a release file was found at URL,
+else #f."
       (let* ((base (basename url))
              (base-url (string-append base-url directory))
              (url  (cond ((and=> (string->uri url) uri-scheme) ;full URL?
@@ -574,7 +577,7 @@ are unavailable."
       (() #f)
       ((first . _)
        (if version
-           ;; find matching release version and return it
+           ;; Find matching release version and return it.
            (find (lambda (upstream)
                    (string=? (upstream-source-version upstream) version))
                  (coalesce-sources candidates))