문서 스타일 가이드 #
이 가이드에는 Matplotlib 설명서의 언어 및 형식에 대한 모범 사례가 포함되어 있습니다.
또한보십시오
기여에 대한 자세한 내용은 문서 작성 섹션을 참조하세요.
설명 언어 #
설명 작성 시 다음 지침은 명확하고 간결한 언어 사용을 위한 것입니다.
용어 #
Matplotlib에는 문서의 신뢰성과 일관성에 대한 표준인 몇 가지 핵심 용어가 있습니다. 상호 교환할 수 없습니다.
용어 |
설명 |
옳은 |
잘못된 |
|---|---|---|---|
프로그래밍을 위한 Matplotlib 작업 공간. |
|
||
그림 내의 서브플롯. 플롯 요소를 포함하며 추가 세부 정보를 플로팅하고 구성하는 일을 담당합니다. |
|
||
시각 자료를 표시하는 다양한 Matplotlib 객체. |
|
||
눈금, 눈금 레이블, 스파인 및 가장자리를 포함하는 참조 표시의 사람이 읽을 수 있는 1차원 개체입니다. |
|
||
명시적 객체 지향 프로그래밍(OOP) |
Matplotlib에서 프로그래밍의 명시적 접근 방식입니다. |
|
|
절대적인,
|
|
|
|
문법 #
주제 #
동작을 지정하는 지시 지시에는 2인칭 명령형 문장을 사용합니다. 2인칭 대명사는 개별적인 문맥과 소유격 참조를 위한 것입니다.
옳은 |
잘못된 |
|---|---|
|
소스 디렉토리에서 Matplotlib를 설치할 수 있습니다. 설치에 문제가 있는 경우 추가 지원을 받을 수 있습니다. |
시제 #
설명을 위해 현재 단순 시제를 사용합니다. 가능한 경우 미래 시제 및 기타 조동사 또는 조동사를 피하십시오.
옳은 |
잘못된 |
|---|---|
시각화를 위한 Matplotlib의 기본 아이디어는 데이터를 가져와 기능과 방법을 통해 변환하는 것입니다. |
Matplotlib은 데이터를 가져와 함수와 메서드를 통해 변환합니다. 다양한 종류의 시각 자료를 생성할 수 있습니다. 이것이 Matplotlib을 사용하기 위한 기초가 될 것입니다. |
보이스 #
능동적인 문장으로 쓰세요. 수동태는 경고 프롬프트와 관련된 상황이나 조건에 가장 적합합니다.
옳은 |
잘못된 |
|---|---|
이 함수 |
그래프는
|
인수가 없으면 함수에서 오류 메시지를 반환합니다. |
인수가 없으면 함수에서 오류 메시지가 표시됩니다. |
문장 구조 #
주어-동사-목적어 순서를 규칙적으로 사용하여 짧은 문장으로 작성하십시오. 문장에서 등위 접속사를 제한하십시오. 대명사 참조 및 종속 접속구를 피하십시오.
옳은 |
잘못된 |
|---|---|
Matplotlib 의 |
Matplotlib 의 |
함수 는 |
함수 는 |
암시적 접근 방식은 간단한 플롯을 생성하기 위한 편리한 지름길입니다. |
플롯 생성을 위한 편리한 바로 가기를 원하는 사용자는 암시적 접근 방식을 사용합니다. |
서식 지정 #
다음 지침은 코드를 통합하고 Matplotlib 설명서에 적절한 형식을 사용하는 방법을 지정합니다.
코드 #
Matplotlib는 Python 라이브러리이며 동일한 문서 표준을 따릅니다.
출력 #
.py예제의 파일을 사용하여 Matplotlib로 시각적 개체를 생성할 때 시각적 개체를 표시하려면 시각적 개체를 matplotlib.pyplot.show표시합니다. 설명서에 Python 출력 라인이 없도록 하십시오.
옳은 |
잘못된 |
|---|---|
plt.plot([1, 2, 3], [1, 2, 3])
plt.show()
|
plt.plot([1, 2, 3], [1, 2, 3])
|
fig, ax = plt.subplots()
ax.plot([1, 2, 3], [1, 2, 3])
fig.show()
|
fig, ax = plt.subplots()
ax.plot([1, 2, 3], [1, 2, 3])
|
재구성된 텍스트 #
Matplotlib는 문서화를 위해 reStructuredText 마크업을 사용합니다. Sphinx는 이러한 문서를 접근성과 가시성을 위해 적절한 형식으로 변환하는 데 도움을 줍니다.
목록 #
글머리 기호 목록은 시퀀싱이 필요하지 않은 항목용입니다. 번호가 매겨진 목록은 결정된 순서대로 작업을 수행하기 위한 용도로만 사용됩니다.
옳은 |
잘못된 |
|---|---|
이 예에서는 세 개의 그래프를 사용합니다. |
이 예에서는 세 개의 그래프를 사용합니다. |
|
|
이 네 단계는 Matplotlib 사용을 시작하는 데 도움이 됩니다. |
다음 단계는 Matplotlib 사용을 시작하는 데 중요합니다. |
|
|
테이블 수
콘텐츠를 구성할 때 reStructuredText 표준과 함께 ASCII 테이블을 사용합니다. Markdown 테이블과 csv-table 지시문은 허용되지 않습니다.
옳은 |
잘못된 |
||||
|---|---|---|---|---|---|
|
| Correct | Incorrect |
| ------- | --------- |
| OK | Not OK |
|
||||
+----------+----------+
| Correct | Incorrect|
+==========+==========+
| OK | Not OK |
+----------+----------+
|
.. csv-table::
:header: "correct", "incorrect"
:widths: 10, 10
"OK ", "Not OK"
|
||||
=========== ===========
Correct Incorrect
=========== ===========
OK Not OK
=========== ===========
|
추가 리소스 #
이 스타일 가이드는 포괄적인 표준이 아닙니다. 문서에 기여하는 방법에 대한 자세한 내용은 아래 링크를 참조하십시오. 이러한 리소스에는 문서 작성에 대한 일반적인 모범 사례가 포함되어 있습니다.
댓글 #
Python 코드의 예에는 같은 줄 앞이나 같은 줄에 주석이 있습니다.
옳은
잘못된