From e2f0ade34848ddae630498cc4a016c5a18f28b3f Mon Sep 17 00:00:00 2001 From: ShenYuhan Date: Mon, 17 Aug 2020 11:24:15 +0800 Subject: [PATCH] add docs for display_name (#752) * add docs for display_name * add docs for display_name --- README.md | 2 ++ docs/README.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index 14c8dcf5..6d8a5978 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,7 @@ class LogWriter(logdir=None, flush_secs=120, filename_suffix='', write_to_disk=True, + display_name='', **kwargs) ``` @@ -108,6 +109,7 @@ class LogWriter(logdir=None, | flush_secs | int | 日志记录消息队列的最大缓存时间，达到此时间则立即写入到日志文件 | | filename_suffix | string | 为默认的日志文件名添加后缀 | | write_to_disk | boolean | 是否写入到磁盘 | +| display_name | string | 在面板中替换实际显示的`logdir`，当日志所在路径过长或想隐藏日志所在路径时可指定此参数 | #### 示例 diff --git a/docs/README.md b/docs/README.md index aa1c4cc9..b69800f7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -95,6 +95,7 @@ class LogWriter(logdir=None, flush_secs=120, filename_suffix='', write_to_disk=True, + display_name='', **kwargs) ``` @@ -108,6 +109,7 @@ class LogWriter(logdir=None, | flush_secs | int | 日志记录消息队列的最大缓存时间，达到此时间则立即写入到日志文件 | | filename_suffix | string | 为默认的日志文件名添加后缀 | | write_to_disk | boolean | 是否写入到磁盘 | +| display_name | string | 在面板中替换实际显示的`logdir`，当日志所在路径过长或想隐藏日志所在路径时可指定此参数 | #### 示例 -- GitLab