整理: モデルの module docstring を簡略化 (#1383)

refactor: module docstring を簡略化
VOICEVOX · Jun 2, 2024 · 4a49201 · 4a49201
1 parent 7cadd4d
commit 4a49201
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 10 deletions.
diff --git a/voicevox_engine/library/model.py b/voicevox_engine/library/model.py
@@ -1,7 +1,7 @@
 """
-ライブラリ機能に関して API と ENGINE 内部実装が共有するモデル
+ライブラリ機能に関して API と ENGINE 内部実装が共有するモデル（データ構造）
 
-「API と ENGINE 内部実装が共有するモデル」については `voicevox_engine/model.py` の module docstring を確認すること。
+モデルの注意点は `voicevox_engine/model.py` の module docstring を確認すること。
 """
 
 from pydantic import BaseModel, Field, StrictStr

diff --git a/voicevox_engine/preset/model.py b/voicevox_engine/preset/model.py
@@ -1,6 +1,7 @@
 """
-プリセット機能に関して API と ENGINE 内部実装が共有するモデル
-「API と ENGINE 内部実装が共有するモデル」については `voicevox_engine/model.py` の module docstring を確認すること。
+プリセット機能に関して API と ENGINE 内部実装が共有するモデル（データ構造）
+
+モデルの注意点は `voicevox_engine/model.py` の module docstring を確認すること。
 """
 
 from pydantic import BaseModel, Field

diff --git a/voicevox_engine/setting/model.py b/voicevox_engine/setting/model.py
@@ -1,6 +1,7 @@
 """
-エンジン設定機能に関して API と ENGINE 内部実装が共有するモデル
-「API と ENGINE 内部実装が共有するモデル」については `voicevox_engine/model.py` の module docstring を確認すること。
+エンジン設定機能に関して API と ENGINE 内部実装が共有するモデル（データ構造）
+
+モデルの注意点は `voicevox_engine/model.py` の module docstring を確認すること。
 """
 
 from enum import Enum

diff --git a/voicevox_engine/tts_pipeline/model.py b/voicevox_engine/tts_pipeline/model.py
@@ -1,6 +1,7 @@
 """
-音声合成機能に関して API と ENGINE 内部実装が共有するモデル
-「API と ENGINE 内部実装が共有するモデル」については `voicevox_engine/model.py` の module docstring を確認すること。
+音声合成機能に関して API と ENGINE 内部実装が共有するモデル（データ構造）
+
+モデルの注意点は `voicevox_engine/model.py` の module docstring を確認すること。
 """
 
 from enum import Enum

diff --git a/voicevox_engine/user_dict/model.py b/voicevox_engine/user_dict/model.py
@@ -1,6 +1,7 @@
 """
-ユーザー辞書機能に関して API と ENGINE 内部実装が共有するモデル
-「API と ENGINE 内部実装が共有するモデル」については `voicevox_engine/model.py` の module docstring を確認すること。
+ユーザー辞書機能に関して API と ENGINE 内部実装が共有するモデル（データ構造）
+
+モデルの注意点は `voicevox_engine/model.py` の module docstring を確認すること。
 """
 
 from enum import Enum