Add notes about slashes in communication ids to tar/zip writer docs

hltcoe · Oct 11, 2023 · f469d1f · f469d1f
1 parent e19f6e0
commit f469d1f
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/concrete/util/file_io.py b/concrete/util/file_io.py
@@ -689,8 +689,11 @@ def write(self, comm, comm_filename=None):
         Args:
             comm (Communication): communication to write to tar file
             comm_filename (str): desired filename of communication
-                within tar file (by default the filename will be the
-                communication id appended with a .concrete extension)
+                within tar file; by default the filename will be the
+                communication id appended with a .concrete extension
+                (it is the user's responsibility to ensure there
+                are no special characters like forward slashes in the
+                communication id!)
         """
         if comm_filename is None:
             comm_filename = comm.id + '.concrete'
@@ -783,8 +786,11 @@ def write(self, comm, comm_filename=None):
         Args:
             comm (Communication): communication to write to zip file
             comm_filename (str): desired filename of communication
-                within zip file (by default the filename will be the
-                communication id appended with a .concrete extension)
+                within zip file; by default the filename will be the
+                communication id appended with a .concrete extension
+                (it is the user's responsibility to ensure there
+                are no special characters like forward slashes in the
+                communication id!)
         '''
         if comm_filename is None:
             comm_filename = comm.id + '.concrete'