Skip to content

Commit 1c4fa21

Browse files
authored
clarify fallback option
only uses build when git is not available
1 parent fd2781d commit 1c4fa21

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ Default is `None`. Specify a two letter [ISO639](https://en.wikipedia.org/wiki/L
109109

110110
### `fallback_to_build_date`
111111

112-
Default is `false`. If set to `true` the plugin will use the time at `mkdocs build` instead of the file's last git revision date. This means the revision date is incorrect, but this can be acceptable if you want your project to also successfully build in environments with no access to GIT.
112+
Default is `false`. If set to `true` the plugin will use the time at `mkdocs build` instead of the file's last git revision date *when git is not available*. This means the revision date can be incorrect, but this can be acceptable if you want your project to also successfully build in environments with no access to GIT.
113113

114114
## Contributing
115115

116-
Contributions are very welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) before putting in any work.
116+
Contributions are very welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) before putting in any work.

0 commit comments

Comments
 (0)