From f469d1f7669c08589d7d2d72582e96957beb9f2c Mon Sep 17 00:00:00 2001 From: Chandler May <457238+ccmaymay@users.noreply.github.com> Date: Wed, 11 Oct 2023 13:34:23 -0400 Subject: [PATCH] Add notes about slashes in communication ids to tar/zip writer docs --- concrete/util/file_io.py | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/concrete/util/file_io.py b/concrete/util/file_io.py index d5bf14f..1d67db6 100644 --- 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'