add warning about not changing data on print

oscar-system · Jan 29, 2025 · c733608 · c733608
1 parent 4a94d08
commit c733608
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/src/DeveloperDocumentation/printing_details.md b/docs/src/DeveloperDocumentation/printing_details.md
@@ -26,6 +26,11 @@ while on the REPL detailed printing is used to show top level objects.
     [...]". In particular, the output of `display` will not work in the
     `jldoctest`s.
 
+!!! warning "changes on print"
+    Printing an object should not change data in any way through changing the representation
+    of the object being printed, nor by generating any cached data that will affect
+    any future computations.
+
 ### Mockup
 
 #### Detailed printing with a new line