docstring

14열

1답변

PEP 257 말한다 : 참조 문 처리 도구가 제 선 결국 비 공백 라인의 최소 압입 동일 문서화 문자열의 두번째 이후 라인으로부터 압흔의 균일 한 양을 제거한다. 문서화 문자열의 첫 번째 줄 (즉, 첫 번째 줄 바꿈까지)에 들여 쓰기는 중요하지 않으며 제거됩니다. 문서화 문자열의 이후 행에 대한 상대적 들여 쓰기는 유지됩니다. 공백 라인은 문서화 문자열의

0열

1답변

docstring에서 파이썬 파일의 저자를 찾으십시오.

docstring에서 Author 문자열을 찾아서 파일 작성자를 찾아서 인쇄하는 프로그램이 있습니다. 필자는 작성자 이름과 저자 이름 뒤에 저자 이름이 오는 파일의 저자를 인쇄하기 위해 아래 코드를 얻을 수있었습니다. 문제가있는 것은 저자 문자열이 전혀 존재하지 않을 때 Unknown을 인쇄하려고하는 것입니다. 즉, docstring의 일부에 Author이

0열

1답변

python의 다른 함수에 따라 함수 docstring을 자동으로 업데이트하는 방법은 무엇입니까?

같은 함수 A를 호출하는 몇 가지 함수 (B1, B2, B3 등 ...)가 있다고 가정합니다. B1, B2, B3의 문서 문자열에 함수 A가 사용하는 매개 변수를 설명하는 일부 텍스트를 넣으려고합니다. 그리고 이것들은 함수 A의 문서화 문자열에서 이미 설명되어 있습니다. 그러나 A의 docstring을 B1, B2, B3으로 복사하고 나중에 함수 A의 do

0열

1답변

쓸 수없는 모듈에 문서 문자열을 추가하는 방법

추가 기능이 프로그래밍 방식으로 기록되는 모듈이 있습니다. 즉 : def fun1(): # function written on 27.02.13 ... def fun2(): # function written on 28.02.13 ... 내가 파일을 수정하지 않고 실행 중에 모듈 자체에 이러한 기능에 docstrings을 추가하고 싶습

7열

1답변

스핑크스에 docstring에서 GPL 통지를 무시하도록하려면 어떻게해야합니까?

나는 나의 파이썬 패키지를 문서화하기 위해 스핑크스를 사용하고있다. 내 모듈에서 모듈 지시문을 사용할 때 : .. automodule:: mymodule :members: 이것은 GPL 통지를 포함한 모든 것을 문서화 문자열에 인쇄합니다. 스핑크스가 docstring/GPL을 무시하도록 지시 할 방법이 있습니까? 아니면 문서에 포함시켜야합니까?

2열

1답변

파이썬 문서화 문자열 프린터는 내가 데이빗 쇼의 LPTHW을 통해 내 방식에 전원을 공급하고있어 내가에, 함수를 만들려고 노력하고 있어요 그래서 여기에 3</p> <p>(신규) 운동 43 여분의 신용에 쓰러진 나무에 왔어요

발행 하나의 커다란 문서 문자열 인 다른 함수를 출력하십시오. 여기 엔진 class Game(object): def __init__(self, start): self.quips = [ "You died. You kinda suck at this.", "Your mom would be proud. If she w

0열

2답변

클래스 인스턴스를 함수로 문서화하기

sphinx autodoc 확장 기능을 사용하여 문서를 만들 때 함수 인 것처럼 클래스 인스턴스 (클래스 자체가 아닌)를 어떻게 문서화 할 수 있습니까? 클래스에는 __call__ 메서드가 정의되어 있습니다.

4열

1답변

Mathjax 표현은 내 문서화 문자열에서이 표현 뭐가 잘못 됐는지 알아 내기 위해 노력했습니다 correclty

렌더링하지. 저는 파이썬 스핑크스 v1.2b에서 sphinx.ext.mathjax 확장자를 사용하고 있습니다. 문서화 문자열 : 하지만 전혀 렌더링 표현이 이상한 경고를 생성하지 계속 : WARNING: Block quote ends without a blank line; unexpected unindent. 을 이상하게도 내가 제거하면 .. math:

10열

1답변

파이썬 docstring에서 매개 변수 참조하기

나는 우리 프로젝트에서 좋은 문서를 확보하기 위해 스핑크스와 자동 인증 기능을 사용한다. 저는 info field lists에 익숙하며 문서에서는 cross-referencing을 잘 알고 있습니다. 그러나 메서드 나 함수에 대한 docstring을 작성할 때 텍스트의 매개 변수를 참조하는 것이 유용하다는 것을 알게되었습니다. 그러나 이것을 구조화 된 방법

10열

4답변

__doc__ 속성

질문에 대한 Inherit docstrings in Python class inheritance가 같이 부모 클래스의 문서화 문자열을 상속하지만, 답변이 방법의 문서화 문자열 처리합니다. 내 질문은 __doc__ 속성으로 부모 클래스의 문서화 문자열을 상속하는 방법입니다. Usecase는 Django rest framework이 뷰 클래스의 문서화 문자열을