From ba72d29ef91793df6cf5c48d43fa40648cd4ed8d Mon Sep 17 00:00:00 2001
From: Lorenzo Cogotti <lcg@doublefourteen.io>
Date: Thu, 15 Dec 2022 19:36:23 +0100
Subject: [PATCH] [examples/replace] Minor fixes to comments and add SYNOPSIS.

---
 examples/rename.lua | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/examples/rename.lua b/examples/rename.lua
index 5811e61..96ef2c4 100755
--- a/examples/rename.lua
+++ b/examples/rename.lua
@@ -2,6 +2,9 @@
 -- Basic mass file renamer using osx and
 -- standard Lua gsub().
 --
+-- SYNOPSIS:
+-- rename.lua <pattern> <replacement> [directory]
+--
 -- Renames every file inside a directory (defaults to current directory).
 -- Trimmed down but functional and useful variant of util-linux rename(1).
 --
@@ -9,7 +12,7 @@
 -- lua rename.lua 'something' 'something_else'
 -- lua rename.lua '(%w+).lua' '%1.lua.bk' src
 --
--- Author Lorenzo Cogotti, The DoubleFourteen Code Forge
+-- Author: Lorenzo Cogotti, The DoubleFourteen Code Forge
 
 local io = require 'io'
 local osx = require 'osx'