# HG changeset patch
# User Franz Glasner <fzglas.hg@dom66.de>
# Date 1570433870 -7200
# Node ID ef1551e7cb16222b95c9017e7156c5b7aa915b6c
# Parent  f8642efe05a10c686800c7687d1d739527fdd534
Docu: get_immediate_remote_repo_version() is documented

diff -r f8642efe05a1 -r ef1551e7cb16 bin/check-ports
--- a/bin/check-ports	Wed Oct 02 09:41:46 2019 +0200
+++ b/bin/check-ports	Mon Oct 07 09:37:50 2019 +0200
@@ -229,6 +229,20 @@
 }
 
 get_immediate_remote_repo_version() {
+    :'Ask a remote repository for the version of a package.
+
+    Args:
+        _repo: the repository name
+        _name: the name of the package
+
+    Returns:
+        0 on success and other status codes otherwise
+
+    Output (Globals):
+        immediate_remote_repo_version_${_repo}: the version of package `_name`
+                                in repo `_repo`
+
+    '
     local _repo _name _version _rv
 
     _repo=$1