pydocstyle.md 948 B

pydocstyle

Python ์Šคํฌ๋ฆฝํŠธ๊ฐ€ Python ๋„ํฌ์ŠคํŠธ๋ง ๊ทœ์น™์„ ์ค€์ˆ˜ํ•˜๋Š”์ง€ ์ •์  ๊ฒ€์‚ฌํ•ฉ๋‹ˆ๋‹ค. ๋” ๋งŽ์€ ์ •๋ณด: https://www.pydocstyle.org/en/latest/.

  • Python ์Šคํฌ๋ฆฝํŠธ ๋˜๋Š” ํŠน์ • ๋””๋ ‰ํ„ฐ๋ฆฌ์˜ ๋ชจ๋“  Python ์Šคํฌ๋ฆฝํŠธ ๋ถ„์„:

pydocstyle {{ํŒŒ์ผ.py|๊ฒฝ๋กœ/๋Œ€์ƒ/ํด๋”}}

  • ๊ฐ ์˜ค๋ฅ˜์— ๋Œ€ํ•œ ์„ค๋ช… ํ‘œ์‹œ:

pydocstyle {{-e|--explain}} {{ํŒŒ์ผ.py|๊ฒฝ๋กœ/๋Œ€์ƒ/ํด๋”}}

  • ๋””๋ฒ„๊ทธ ์ •๋ณด ํ‘œ์‹œ:

pydocstyle {{-d|--debug}} {{ํŒŒ์ผ.py|๊ฒฝ๋กœ/๋Œ€์ƒ/ํด๋”}}

  • ์ด ์˜ค๋ฅ˜ ์ˆ˜ ํ‘œ์‹œ:

pydocstyle --count {{ํŒŒ์ผ.py|๊ฒฝ๋กœ/๋Œ€์ƒ/ํด๋”}}

  • ํŠน์ • ๊ตฌ์„ฑ ํŒŒ์ผ ์‚ฌ์šฉ:

pydocstyle --config {{๊ฒฝ๋กœ/๋Œ€์ƒ/๊ตฌ์„ฑ_ํŒŒ์ผ}} {{ํŒŒ์ผ.py|๊ฒฝ๋กœ/๋Œ€์ƒ/ํด๋”}}

  • ํ•˜๋‚˜ ์ด์ƒ์˜ ์˜ค๋ฅ˜ ๋ฌด์‹œ:

pydocstyle --ignore {{D101,D2,D107,...}} {{ํŒŒ์ผ.py|๊ฒฝ๋กœ/๋Œ€์ƒ/ํด๋”}}

  • ํŠน์ • ๊ทœ์•ฝ์˜ ์˜ค๋ฅ˜ ๊ฒ€์‚ฌ:

pydocstyle --convention {{pep257|numpy|google}} {{ํŒŒ์ผ.py|๊ฒฝ๋กœ/๋Œ€์ƒ/ํด๋”}}