-
Formatting!DEV/Python 2021. 7. 20. 13:07
유다시티 과제하는데 포맷팅에서 빠꾸를 먹었다. 테스트 코드 다 통과해서 가볍게 넘길 줄 알았는데! ㅋㅋ
Always keep in mind that there are a plethora of command-line tools (pycodestyle, pylint) or websites (http://pep8online.com/) to check if the violations aren’t egregious (e.g. long lines, a few style missteps, but mostly clean and well-formatted),
PEP8 online check
pep8online.com
Great job. It’s important that the docstring comments that you leave capture the interface of the unit of code. Implementation-level details, except in extreme cases, belong as normal comments inline with the code. The docstring discusses what the function does, and possibly why, but doesn’t dwell too much on how. You can read more on docstring conventions here and on pydoctyle here
Usage — pydocstyle 6.1.1 documentation
Note When using any of the --select, --ignore, --add-select, or --add-ignore command line flags, it is possible to pass a prefix for an error code. It will be expanded so that any code beginning with that prefix will match. For example, running the command
www.pydocstyle.org
파이썬 할 때는 pycodestyle로 주기적으로 린팅 하면서 작업해야겠다. 가장 귀찮았던 작업은, 프로젝트 원작자가 주석을 너무 길게 달아놔서 한 줄에 79자 제한을 넘겨서 떴던 많은 경고를 다 고쳐야 했던 작업이다. aggressive 포맷팅을 하더라도 수동으로 고쳐줘야 하는 부분이 있었다. 그나저나 프로젝트 퀄리티가 엄청 좋다. 다음번 과제도 기대되는걸! 👩💻