From a430403c7e7dd33de880c9b3bffb5ab554f81c69 Mon Sep 17 00:00:00 2001 From: jvoisin Date: Sun, 1 Jul 2018 23:27:24 +0200 Subject: [PATCH] Document in our implementation notes how revisions are handled and why --- doc/implementation_notes.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/implementation_notes.md b/doc/implementation_notes.md index 59e7d94..21e8dea 100644 --- a/doc/implementation_notes.md +++ b/doc/implementation_notes.md @@ -9,6 +9,16 @@ that only cleans the superficial metadata of your file, but not the ones that might be in **embeded** resources. Like for example, images in a PDF or an office document. +Revisions handling +------------------ + +Revisions are handled according to the principle of least astonishment: they are entirely removed. + +- Either the users aren't aware of the revisions, are thus they should be deleted. For example journalists that are editing a document to erase mentions sources mentions. + +- Or they are aware of it, and will likely not expect MAT2 to be able to keep the revisions, that are basically traces about how, when and who edited the document. + + Race conditions ---------------