!6461 [MD] fix comment in filewriter

Merge pull request !6461 from liyong126/fix_filewriter_comment
2020-09-18 20:17:56 +08:00 · 2020-09-18 20:17:56 +08:00 · 55e90cc774
parent 28f03ae246 1cb8dec1e8
commit 55e90cc774
1 changed files with 3 additions and 0 deletions
--- 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).