Commit Graph

7 Commits

Author SHA1 Message Date
Thomas O'Donnell 9044f9e14c
docs: Update defaults in config docs ()
Have updated some of the config docs to correct the git_status default
that was incorrect. Have also taken the time to switch some of the
format strings to use toml literal strings rather than normal strings to
simplify the escape strings.
2020-10-12 00:10:39 -04:00
Mick Hohmann e7a83aa445
docs: fix wrong syntax in the format string and standardize doc tense () 2020-10-08 16:54:59 -04:00
Jeff Byrnes 476edc4ca1
docs: clarify missing info in 0.45.0 migration doc () 2020-10-01 16:48:14 -04:00
Matan Kushner ce73f6347f
docs(directory): fix $read_only variable names
Fixes 
2020-09-30 18:40:25 -04:00
Matan Kushner 59f939e25c
chore: update v0.45.0 removal notice ()
* chore: update deprecation notice

* Add deprecation page to sidebar

* Replace the use of "deprected" with "removed"
2020-09-29 12:35:11 -04:00
Thomas O'Donnell 7b09c86b0f
docs(git_status): Update git_status module docs ()
* docs: Update git_status module docs

Have updated the configuration docs for the `git_status` to remove a
non-existing option and to add an example for how to achieve the same
effect as with the new format strings.

* Add git_status changes to migration guide

Have added the change to the sync count to the migration guide. I also
corrected a few typos in the configuration.
2020-09-26 19:15:52 +02:00
Matan Kushner 17687be1cb
docs: add a migration guide for the format string changes ()
* Start writing migration guide

* Add prefix/suffix migration to guide

* Update docs/migrating-to-0.45.0/README.md

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>

* Update docs/migrating-to-0.45.0/README.md

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>

* Add missing quote

* Detail the modules affected by the change

* Document character and time migration

Co-authored-by: Thomas O'Donnell <andytom@users.noreply.github.com>
2020-09-22 15:48:37 -04:00