Skip to content

Commit 6cbab57

Browse files
heumsiSotaneum
andauthored
읽기 좋도록 수평선과 <br> 태그 추가 (#12)
* Fix typo and add horizontal lines, <br> tags for readability * Merge remote-tracking branch 'origin/master' * [#12] 의견 반영 Co-authored-by: sotaneum <gnyontu39@gmail.com>
1 parent 6bf7264 commit 6cbab57

7 files changed

Lines changed: 325 additions & 218 deletions

File tree

Google Python Style Guide kor.md

Lines changed: 316 additions & 212 deletions
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
- Python은 구글에서 메인으로 사용하는 동적 언어입니다.
2-
- 이 스타일 가이드는 Python 프로그램에서 _해야할 것들과 하지 말아야할_ 들을 적어놓았습니다.
2+
- 이 스타일 가이드는 Python 프로그램에서 _해야 할 것들과 하지 말아야 할_ 들을 적어놓았습니다.
33
- 코드 형식을 정확하게 하는 것들 돕기 위해, 우리는 [settings file for Vim](google_python_style.vim)을 만들었습니다.
44
- Emacs 편집기에서는 기본 설정값으로 사용하면 됩니다.
55
- 많은 팀에서 형식에 대한 논쟁을 피하기 위해 [yapf](https://github.com/google/yapf/) auto-formatter 을 사용합니다.

Google Python Style Guide/2. Python 언어 규칙/2.1 Lint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
#### 2.1.1 정의
1010

11-
- `pylint`는 파이썬 소스코드에서 버그와 스타일 문제를 찾기위한 툴입니다. (`pylint`는 빌나 컴파일시 에러외에 `추가`로 오류검사를 할 수 있는 도구라고 생각하면 될 것 같습니다.)
11+
- `pylint`는 파이썬 소스코드에서 버그와 스타일 문제를 찾기 위한 툴입니다. (`pylint`는 빌나 컴파일 시 에러 외에 `추가`로 오류검사를 할 수 있는 도구라고 생각하면 될 것 같습니다.)
1212
- 일반적으로 C나 C++와 같은 비동적 프로그래밍 언어에서의 컴파일러를 통해 잡히는 문제를 찾아냅니다.
1313
- 파이썬의 동적인 특성때문에 몇몇 경고들은 정확하지 않을 수 있지만 드물게 발생합니다.
1414

Google Python Style Guide/2. Python 언어 규칙/2.14 True, False 평가.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
- 항상 `if foo is None:`(혹은 `is not None`)을 통해 `None` 값을 확인하세요.
3434
- 예를 들어, 기본값이 `None`인 변수나 인자를 어떤 값으로 설정했는지 확인할 때, 어떤 값이 boolean의 `False` 값일 수 있습니다.
35-
- `==`를 사용해서 boolean 변수인 `False`와 비교하지 마세요. 대신 `if not x:`를 사용하세요. `False``None`구별해야할 경우 `if not x and is not None:`와 같은 식으로 연결하세요.
35+
- `==`를 사용해서 boolean 변수인 `False`와 비교하지 마세요. 대신 `if not x:`를 사용하세요. `False``None`구별해야 할 경우 `if not x and is not None:`와 같은 식으로 연결하세요.
3636
- sequences(strings, lists, tuples)의 경우 빈 sequences는 `False`이므로 `if len(seq):` 혹은 `if not len(seq):` 보다 `if seq:` 혹은 `if not seq:`가 더 바람직합니다.
3737
- 정수(integer)를 처리할때, 암묵적(implicit) `False`는 이점보다 더 많은 위험을 가져올 수 있습니다(즉 `None`을 0으로 잘못 처리합니다.). (`len()`의 결과가 아닌)정수라고 알려진 값을 정수 0과 비교할 수 있습니다.
3838

Google Python Style Guide/2. Python 언어 규칙/2.4 예외처리.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
- 사용하는 동안, 기존에 존재하는 예외 클래스(exception class)로부터 상속을 받아야 합니다.
8484
- 예외 이름은 `Error`로 끝나야 하고 말더듬이(stutter)로 시작하면 안됩니다.(`foo.fooError`).
8585
- 예외를 다시 발생시키거나 쓰레드의 가장 바깥 쪽 블록에 있지않으면 절대 포괄적인 `except:`문을 사용하거나 `Exception`, `StandardError`을 사용하지마세요. (그리고 에러메시지를 출력하세요.) Python은 이와 관련해서 매우 관용적이며 `except:` 모든 오탈자를 비롯하여, sys.exit() 호출, Ctrl+C로 인한 인터럽트, 유닛테스트 실패와 마지막으로 당신이 포착을 원하지 않았던 다른 모든 종류의 예외들까지 모두 잡아낼 것입니다.
86-
- 코드상에서 `try`/`except` 블록의 수를 최소화시키세요. `try`문의 내부가 커질수록 예외는 당신이 예외가 발생할것이라 예상하지 않았던 코드에 의해 점점 더 발생할 것입니다. 이러한 상황에서, `try`/`except` 블록은 진짜 검출해야할 에러를 가리게 됩니다.
86+
- 코드상에서 `try`/`except` 블록의 수를 최소화시키세요. `try`문의 내부가 커질수록 예외는 당신이 예외가 발생할것이라 예상하지 않았던 코드에 의해 점점 더 발생할 것입니다. 이러한 상황에서, `try`/`except` 블록은 진짜 검출해야 할 에러를 가리게 됩니다.
8787
- 예외가 `try` 블록에서 발생하던 안하던 `finally`절은 코드를 실행시킨다. 이건 가끔 깔끔히 하는데 유용합니다. 예를들어, 파일을 닫을 때 가 그 예입니다.
8888
- 예외를 포착했을때, `,` 보다 `as` 를 사용하세요. 예시는 다음과 같습니다.
8989

Google Python Style Guide/3. Python 스타일 규칙/3.16 네이밍.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
<a id="s3.16.1-names-to-avoid"></a>
2323

24-
#### 3.16.1 피해야할 이름
24+
#### 3.16.1 피해야 할 이름
2525

2626
1. 아래와 같은 특별한 경우를 제외한 단일 글자는 피합니다.
2727

script/build.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ def insert_part_in_readme(part_path, number, all):
7777
part_tree.append({"link":link, "title":title})
7878
if part_tree:
7979
tree.append(part_tree)
80+
# 파트가 시작하는 부분에 라인 추가 (d5e507c / #12)
81+
lines.append("\n---\n")
8082
write_readme(target_readme, lines, True if number == "1" else False)
8183

8284
def tree_to_contents():
@@ -105,7 +107,8 @@ def chapter_build(chapter_path, number, all):
105107
f = open(from_readme, 'r')
106108
data = f.readlines()
107109
f.close()
108-
readme.append("".join(chapter_header) + "".join(data))
110+
# 챕터가 시작하는 부분에 <br> 추가 (d5e507c / #12)
111+
readme.append("\n<br>\n" + "".join(chapter_header) + "".join(data))
109112

110113
def build():
111114
to_readme = "./Google Python Style Guide kor.md"

0 commit comments

Comments
 (0)