From 33a2ce30f587a2da98237e33cae761f962b4c8b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hampus=20T=C3=A5gerud?= Date: Thu, 20 Jun 2024 19:07:39 +0200 Subject: [PATCH] Update file header placeholders documentation to match the code (#1737) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index db054fc50..652243ef8 100644 --- a/README.md +++ b/README.md @@ -826,9 +826,9 @@ It is common practice to include the file name, creation date and/or the current * `{file}` - the name of the file * `{year}` - the current year * `{created}` - the date on which the file was created -* `{created.name}` - the name of the user who first committed the file -* `{created.email}` - the email of the user who first committed the file * `{created.year}` - the year in which the file was created +* `{author.name}` - the name of the user who first committed the file +* `{author.email}` - the email of the user who first committed the file For example, a header template of: @@ -844,7 +844,7 @@ Will be formatted as: // Created by John Smith on 01/02/2016. ``` -**NOTE:** the `{year}` value and `{created}` date format are determined from the current locale and timezone of the machine running the script. `{created.name}` and `{created.email}` requires the project to be version controlled by git. +**NOTE:** the `{year}` value and `{created}` date format are determined from the current locale and timezone of the machine running the script. `{author.name}` and `{author.email}` requires the project to be version controlled by git. FAQ