이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- SymPy
- 기술 문서 작성자:
- Soumi7
- 프로젝트 이름:
- docstring 전체의 일관성 - Sympy 문서
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
개요 :
Sympy 문서의 현재 상태 및 이전 작업 :
SymPy의 공식 스타일 가이드 작성 작업이 완료되었습니다.
Lauren Glattly의 GSoD 프로젝트는 SymPy 문서 스타일 가이드에서 찾을 수 있는 SymPy docstring용 스타일 가이드를 작성했습니다.
특수 하위 모듈 및Solvers.py 파일의 docstring이 새로운 스타일 가이드의 가이드라인을 일관되게 따르도록 수정되었습니다.
코드베이스의 다른 모든 문자열 문서도 새 스타일 가이드에 따라 수정해야 했습니다.
제안된 작업 :
SymPy의 대부분의 docstring은 여전히 최신 스타일 가이드를 따르지 않습니다. 이 프로젝트의 목표는 이 가이드를 준수하도록 SymPy 전체에서 docstring을 업데이트하는 것입니다.
멘토와 프로젝트에 대해 논의했습니다. 다음은 토론 링크입니다.
sympy의 코드베이스 전체에 걸쳐 최신 스타일 가이드를 준수하도록 docstring을 수정하는 것은 큰 작업이며 프로젝트를 이 작업에만 제한해야 한다고 판단되었습니다.
프로젝트에서 맡은 업무는 기존 문서 주석을 업데이트하기 위한 새 가이드를 구현하는 동시에 언어 사용이나 용어와 같은 다른 불일치를 수집하고 해결하는 것입니다.
기존 하위 섹션의 순서는 나중에 또는 별도의 작업으로 변경하거나 결정할 수 있습니다.
매개변수 섹션 추가와 함께 예를 더 추가하여 여러 값이 매개변수에 전달될 때 결과의 차이를 보여줍니다.
문제 및 함정 섹션에 어려운 예시를 계속 추가합니다.
참여: - #17887 : 문제 #17887 작업 완료: 특별 하위 모듈에서 누락된 docstring 섹션이 추가되었습니다. L님이 수정한 Specials 하위 모듈의 일부 함수에 누락된 매개변수 및 예시 섹션을 추가했습니다. Glattly: 최신 스타일 가이드를 따르고 향후 docstring의 모델이 됩니다.
병합된 PR 링크 : https://github.com/sympy/sympy/pull/19334
- #19591 : 문제 #19591은 문서 스타일 가이드를 추적합니다. 최신 스타일 가이드를 준수하도록 core.sympify 문서 텍스트를 수정하는 PR을 추가했습니다. 다양한 매개변수의 사용에 관한 체계적인 설명과 예시를 추가했습니다.
PR 링크: https://github.com/sympy/sympy/pull/19613
프로젝트 목표
타임라인 8월 17일 이전 :
- 조직에 계속 기여합니다.
- 사용자 문서 및 sympy의 현재 버전에 대해 자세히 알아봅니다.
- 프로젝트를 구현하는 데 도움이 되는 기법과 기술을 알아봅니다.
커뮤니티 유대감 : (2020년 8월 17일~9월 13일)
- 통신 채널과 시간을 설정합니다 (시차로 인해).
- 목표를 수정하고 양측의 기대치를 설정합니다.
- 모듈이 업데이트되는 순서를 논의합니다.
- 최신 docstring 스타일 가이드를 준수하도록 모듈 수정 순서를 최종적으로 결정합니다.
문서 작성 기간(2020년 9월 14일~2020년 11월 30일) :
매주 달성할 목표를 설정합니다. 가급적 주당 하나 이상의 모듈 또는 하위 모듈의 문서 문자열을 업데이트합니다.
이러한 모든 모듈의 기본 목표는 누락된 섹션을 추가하고 최신 스타일 가이드를 따르도록 docstring을 재구성하는 것입니다. 여기에는 매개변수에 다른 값을 전달할 때 얻은 다양한 결과를 보여주는 것이 포함됩니다. 까다로운 출력은 모두 실수 및 함정 섹션에 추가됩니다.
1주 차 ( 9월 14일~9월 21일) : 핵심
2주 차 (9월 22일~9월 29일) : 함수 : 하위 모듈 조합론
3주차 (9월 30일~10월 6일) : 함수
4주차 (10월 7일~10월 14일) : 간소화, 암호화
5주차 (10월 15일~10월 21일) : 디오판틴
6주차 (10월 22일~10월 29일):Holonomic :Operations 하위 모듈
7주차 (10월 30일~11월 7일) : 적분 모듈(integrals.integrals), Meijer G 함수를 사용하여 적분 계산
8주차 (11월 8일~11월 15일) : 물리, 카테고리 모듈 끝의 함수, 코드 생성 모듈, 하위 모듈 특수
9주차 (11월 16일~11월 23일) : 물리학, 카테고리 모듈 마지막 부분의 함수, 코드 생성 모듈, 하위 모듈 특별
10주 차(11월 24일~11월 30일) : Gotchas and Pitfalls(주의사항 및 함정) 섹션
2020년 11월 30일~12월 5일 18:00(UTC): 최종 프로젝트 제출 및 보고서 작성
2020년 12월 3일~10일 18:00(UTC): 프로젝트 성공 및 멘토와의 협업 경험 제출
여기서 언급된 모듈의 순서는 멘토와 추가 논의 후에 변경할 수 있습니다.
멘토가 제안한 것처럼 업데이트가 더 쉬운 모듈을 먼저 업데이트하는 데 중점을 둔 다음 복잡한 모듈로 넘어갈 것입니다.
이 프로젝트에 적합한 이유
저는 컴퓨터 과학과 관련된 기술 문서 작성 경험이 있고 git 및 github에 능숙하므로 이 프로젝트에 적합한 인재라고 생각합니다.
성공적으로 병합된 sympy의 최신 스타일 가이드로 문서를 업데이트하기 위해 PR을 제출했으므로 워크플로에 확신을 가지고 정기적으로 기여하고 있습니다.
처음에 참여하기 시작하면서 몇 가지 오류가 발생했습니다. 변경사항을 커밋하기 전에 매번 테스트를 실행하고 문서를 빌드하는 것이 매우 중요하므로 이제는 익숙해졌습니다.
이 프로젝트에 기여할 수 있어 기쁘게 생각하며 기대하고 있습니다.