From 49515358a0fa558fd50d349915fbd4a703bcc2ab Mon Sep 17 00:00:00 2001 From: "Javier G. Sogo" Date: Tue, 18 Dec 2018 15:56:39 +0100 Subject: [PATCH] document tools.apple_dot_clean (closes #977) --- reference/tools.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/reference/tools.rst b/reference/tools.rst index 5591bd0999db..bfb3e871c451 100644 --- a/reference/tools.rst +++ b/reference/tools.rst @@ -1479,3 +1479,18 @@ tools.latest_vs_version_installed() Returns a string with the major version of latest Microsoft Visual Studio available on machine. If no Microsoft Visual Studio installed, it returns ``None``. + + +tools.apple_dot_clean() +----------------------- + +.. code-block:: python + + def apple_dot_clean(folder) + +Remove recursively all ``._`` files inside ``folder`` containing metadata information for Apple +operating systems, these files can appear when unzipping a file that has been created in Macos. +This tool will remove only files matching the pattern if there is file without the prefix too. + +Parameters: + - **folder** (Required): root folder to start deleting ``._`` files.