-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
close #KLI-165 Webアプリによる走行ログ可視化 #4
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docstring関連で変更お願いします🙏
src/csv_to_json.py
Outdated
"""CSVファイルをJSONファイルに変換するクラス.""" | ||
|
||
def __init__(self, csv_file_path: str) -> None: | ||
"""コンストラクタ.""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"""コンストラクタ.""" | |
"""コンストラクタ.""" | |
Args: | |
csv_file_path (str): CSVファイルのパス | |
""" |
こんな感じで、他の箇所も含めて、docstringに Args などを追記してください。
src/csv_to_json.py
Outdated
self._write_json(data) | ||
|
||
def _read_csv(self) -> List[dict]: | ||
"""CSVファイルを読み込み、辞書のリストを返す.""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ここも引数はないけど返り値について、Return: という形で、返り値についての型と説明を明記してください。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
チェックリスト
変更点
添付資料