Docstring 수정

[ebang091]

현재 멘토님께서 조언해주신대로 PEP8 (PEP 257)을 따르는 주석으로 수정하다가, 전체적인 주석이 그러한 상태라는 걸 알고나서 전반적으로 수정하고 싶다고 생각했습니다.

동참하고 싶으신 분이 계시거나, 코드를 읽다가 이렇게 수정했으면 좋겠다는 의견이 있으셨다면 들려주신다면 감사할 것 같습니다.

제 계획은 우선 다음과 같습니다 :

1. event.py 등 각 py 파일의 docstring을 랜더링 시 개행된 형태로 수정합니다.

꼴의 주석을

위와 같은 식으로 바꾸려고 합니다. (예시입니다.)
멘토님께서 공유해주신 문서 를 참고할 예정입니다.

2. 가능하면 가독성을 높이는 쪽으로 Raises, Params 와 관련된 부분도 수정하려고 합니다.

같이 할 분이 계셔도 너무 좋을 거 같습니다 ㅎㅎ

[starcat37]

안녕하세요! 저도 참여하고 싶습니다:) 다만 제가 8/5 모임을 참여하지 못했는데 혹시 이 이슈와 관련해서 추가로 알아두어야 하는 사항이 있을까요?

[heehehe]

@ebang091 너무 좋은 것 같습니다!!😃
마침 저희 3조에서 #34 통해서 설명이 없던 class에 대해서 주석 추가하는 작업 진행해보고 있었는데요,
의견 주신 Docstring 전반적인 수정이랑 같이 진행해보면 어떨까 싶습니다!

추가하려던 event 및 추가한 내용은 아래 링크에서 확인해 보실 수 있는데요,
https://www.notion.so/open-up/class-method-270b319a9b804d2f88d59f5b5f5bc1b4?pvs=4

#8 처럼 브랜치 하나 만들어서 추가해봐도 좋을 것 같은데 어떠실까요?!

c.c @starcat37 @mjs1995 @mikaniz @sean-k1

[ebang091]

@starcat37 아니요! 추가적으로 아실 사항은 없는 것 같습니다!
@heehehe 오 노션도 공유해주셔서 너무 감사합니다! 노션 페이지 하나 파서 각자 수정하고 싶은 부분 나누어서 확인하면서 수정해도 넘 좋을 것 같아요 ㅎㅎㅎ
브랜치 하나 파는 것도 넘 필요한 것 같아요 적극 찬성입니다!!

[ebang091]

https://www.notion.so/open-up/docs-improve-comments-830b0113c0a2417e813305443c4de23d?pvs=4
@starcat37 @starcat37 @mjs1995 @mikaniz @sean-k1 3조 분들과 협업하고 싶어서 만들었습니다 ㅎㅎ

1. 노션이 더 협업하기 좋을 것 같아 위 사이트에 협업 공간 만들어두었습니다!

자유롭게 편집해주셔도 됩니다..!

2. 브랜치 docs/improve-comments 로 파두었습니다 !

[heehehe]

@ebang091 오 정말 감사합니다!! 노션에서 작업하고 댓글로 의견들 남기겠습니다ㅎㅎ

(저희 3조 분들 필수 참여는 아니고, 원하시는 분들 자유롭게 함께해주시면 좋을 것 같습니다😃)

[dongwook-chan]

줄리앙이 너무 좋아하실 것 같아요 ㅜㅜ
저도 제가 구현했던 쿼리이벤트 주석 참여하겠습니다!

[chungeun-choi]

혹시 껴도 된다면 남는 자리 참여해도 괜찮을까요? ㅎ

[ebang091]

@cucuridas 물론이죠!! 환영입니다 😄

[heehehe]

julien-duponchelle#464 merge 완료로 issue close 하겠습니다 :)
당시에 작업하시느라 모두 고생 많으셨었어요!!😃