Skip to content

Commit

Permalink
Update file header placeholders documentation to match the code (#1737)
Browse files Browse the repository at this point in the history
  • Loading branch information
hampustagerud committed Jun 20, 2024
1 parent dd989a4 commit 33a2ce3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down

0 comments on commit 33a2ce3

Please sign in to comment.