File 0487-Clarify-filelib-fold_files-5-docs.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0487-Clarify-filelib-fold_files-5-docs.patch of Package erlang (Revision f9f0862e6f7065f6a4181181ca03db89)

Currently displaying revision f9f0862e6f7065f6a4181181ca03db89 , Show latest

From 94c7ca639aaf0a1f4caa643be6b61f30cb9ae1dc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Wed, 7 Sep 2022 09:01:58 +0100
Subject: [PATCH] Clarify filelib:fold_files/5 docs

Clarify that the regular expression given to `filelib:fold_files/5`
acts only on the basename of the files, and not over any preceding
directory components in the filename.

Co-authored-by: Tom Davies <TD5@users.noreply.github.com>
---
 lib/stdlib/doc/src/filelib.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/stdlib/doc/src/filelib.xml b/lib/stdlib/doc/src/filelib.xml
index 8ca5f30901..f07d878110 100644
--- a/lib/stdlib/doc/src/filelib.xml
+++ b/lib/stdlib/doc/src/filelib.xml
@@ -137,7 +137,8 @@
       <fsummary>Fold over all files matching a regular expression.</fsummary>
       <desc>
         <p>Folds function <c><anno>Fun</anno></c> over all (regular) files
-          <c><anno>F</anno></c> in directory <c><anno>Dir</anno></c> that match
+          <c><anno>F</anno></c> in directory <c><anno>Dir</anno></c> whose basename
+          (for example, just <c>"baz.erl"</c> in <c>"foo/bar/baz.erl"</c>) matches
           the regular expression <c><anno>RegExp</anno></c> (for a description
           of the allowed regular expressions,
           see the <seeerl marker="re"><c>re</c></seeerl> module).
-- 
2.35.3

Places

File 0487-Clarify-filelib-fold_files-5-docs.patch of Package erlang (Revision f9f0862e6f7065f6a4181181ca03db89)

Places