Closed
Description
현재 멘토님께서 조언해주신대로 PEP8 (PEP 257)을 따르는 주석으로 수정하다가, 전체적인 주석이 그러한 상태라는 걸 알고나서 전반적으로 수정하고 싶다고 생각했습니다.
동참하고 싶으신 분이 계시거나, 코드를 읽다가 이렇게 수정했으면 좋겠다는 의견이 있으셨다면 들려주신다면 감사할 것 같습니다.
제 계획은 우선 다음과 같습니다 :
1. event.py 등 각 py 파일의 docstring을 랜더링 시 개행된 형태로 수정합니다.
꼴의 주석을
위와 같은 식으로 바꾸려고 합니다. (예시입니다.)
멘토님께서 공유해주신 문서 를 참고할 예정입니다.
2. 가능하면 가독성을 높이는 쪽으로 Raises, Params 와 관련된 부분도 수정하려고 합니다.
같이 할 분이 계셔도 너무 좋을 거 같습니다 ㅎㅎ