diff options
| author | jvoisin | 2018-07-01 23:27:24 +0200 |
|---|---|---|
| committer | jvoisin | 2018-07-01 23:27:24 +0200 |
| commit | a430403c7e7dd33de880c9b3bffb5ab554f81c69 (patch) | |
| tree | 4120c989308fdd9d0b023446dc621a155c25b217 | |
| parent | bee56a57ce0f45c51386423d508ba06836be366e (diff) | |
Document in our implementation notes how revisions are handled and why
| -rw-r--r-- | doc/implementation_notes.md | 10 |
1 files changed, 10 insertions, 0 deletions
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 | |||
| 9 | the ones that might be in **embeded** resources. Like for example, | 9 | the ones that might be in **embeded** resources. Like for example, |
| 10 | images in a PDF or an office document. | 10 | images in a PDF or an office document. |
| 11 | 11 | ||
| 12 | Revisions handling | ||
| 13 | ------------------ | ||
| 14 | |||
| 15 | Revisions are handled according to the principle of least astonishment: they are entirely removed. | ||
| 16 | |||
| 17 | - 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. | ||
| 18 | |||
| 19 | - 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. | ||
| 20 | |||
| 21 | |||
| 12 | Race conditions | 22 | Race conditions |
| 13 | --------------- | 23 | --------------- |
| 14 | 24 | ||
