From 5b0a23ebabcf5473f36f9e7666182e2b55b2f683 Mon Sep 17 00:00:00 2001 From: Michael Bryan Date: Sun, 21 Jul 2019 02:40:58 +0800 Subject: [PATCH] Updated the documentation --- book-example/src/for_developers/backends.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/book-example/src/for_developers/backends.md b/book-example/src/for_developers/backends.md index f8ddb0f3..ec7ecd79 100644 --- a/book-example/src/for_developers/backends.md +++ b/book-example/src/for_developers/backends.md @@ -261,6 +261,10 @@ in [`RenderContext`]. > **Note:** There is no guarantee that the destination directory exists or is > empty (`mdbook` may leave the previous contents to let backends do caching), > so it's always a good idea to create it with `fs::create_dir_all()`. +> +> If the destination directory already exists, don't assume it will be empty. +> To allow backends to cache the results from previous runs, `mdbook` may leave +> old content in the directory. There's always the possibility that an error will occur while processing a book (just look at all the `unwrap()`'s we've written already), so `mdbook` will