From 1cb8dec1e8fb7115f8975bc190aa272e447647bf Mon Sep 17 00:00:00 2001
From: liyong <liyong126@huawei.com>
Date: Fri, 18 Sep 2020 11:21:40 +0800
Subject: [PATCH] fix fileWriter comment

---
 mindspore/mindrecord/filewriter.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/mindspore/mindrecord/filewriter.py b/mindspore/mindrecord/filewriter.py
index fd3a3f188f5..c2807bb6549 100644
--- a/mindspore/mindrecord/filewriter.py
+++ b/mindspore/mindrecord/filewriter.py
@@ -34,6 +34,9 @@ class FileWriter:
     """
     Class to write user defined raw data into MindRecord File series.
 
+    Note:
+        The mindrecord file may fail to be read if the file name is modified.
+
     Args:
         file_name (str): File name of MindRecord File.
         shard_num (int, optional): Number of MindRecord File (default=1).