이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- SymPy
- 테크니컬 라이터:
- Soumi7
- 프로젝트 이름:
- 문서 문자열 간의 일관성 - Sympy 문서
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
개요 :
Sympy의 현재 상태 문서 및 이전 작업 :
SymPy의 공식 스타일 가이드를 만드는 작업이 완료되었습니다.
Lauren Glattly의 GSoD 프로젝트는 SymPy docstrings를 위한 스타일 가이드를 만들었습니다. 이 스타일 가이드는 SymPy 문서 스타일 가이드에서 확인할 수 있습니다.
특수 하위 모듈 및 Solrs.py 파일의 docstring이 새로운 스타일 가이드의 가이드라인을 일관되게 준수하도록 수정되었습니다.
코드베이스의 다른 모든 docstring도 새로운 스타일 가이드를 준수하도록 수정해야 했습니다.
제안된 저작물 :
SymPy의 대부분의 docstring은 여전히 최신 스타일 가이드를 따르지 않습니다. 이 프로젝트의 목표는 SymPy 전체에서 docstring을 업데이트하여 이 가이드를 준수하도록 하는 것입니다.
멘토와 프로젝트에 대해 논의했습니다. 다음은 토론으로 연결되는 링크입니다.
sympy의 코드베이스 전체에 걸쳐 최신 스타일 가이드를 준수하도록 문서 문자열을 수정하는 것은 중대한 작업이며 이 프로젝트에만 적용되어야 한다는 결론을 내렸습니다.
이 프로젝트에서는 기존 docstring을 업데이트하는 새 가이드를 구현하는 한편 언어 사용이나 용어와 같은 기타 불일치 사항을 수집하고 해결하는 작업을 수행했습니다.
기존 하위 섹션의 순서는 변경하거나 나중에 또는 별도의 작업으로 결정할 수 있습니다.
매개변수 추가와 함께 예를 더 추가하여 매개변수에 서로 다른 값이 전달될 때 결과의 차이를 보여줍니다.
함정 및 함정 섹션에 까다로운 예시를 계속 추가합니다.
기여: - #17887 : 문제 #17887: 특수 하위 모듈에서 누락된 docstring 섹션을 추가했습니다. L이 편집한 특수 하위 모듈의 일부 함수에 누락된 매개변수 및 예시 섹션을 추가했습니다. 최신 스타일 가이드를 따르고 향후 docstring을 위한 모델로 기능합니다.
병합된 PR에 대한 링크 : https://github.com/sympy/sympy/pull/19334
- #19591 : 문제 #19591 은 문서 스타일 가이드를 추적합니다. 최신 스타일 가이드를 준수하도록 core.sympify docstring을 편집하는 PR을 추가했습니다. 다양한 매개변수 사용에 관한 구조화된 설명과 예를 추가했습니다.
PR 링크: https://github.com/sympy/sympy/pull/19613
프로젝트 목표
일정 8월 17일 이전 :
- 조직에 지속적으로 기여합니다.
- 사용자 문서 및 심피의 현재 버전을 숙지합니다.
- 프로젝트를 구현하는 데 도움이 될 기술과 기술을 학습합니다.
커뮤니티 유대 : (2020년 8월 17일~9월 13일)
- 시차로 인한 커뮤니케이션 채널과 시간을 설정합니다.
- 목표를 세부적으로 조정하고 양측의 기대치를 설정합니다.
- 모듈이 업데이트되는 순서 논의
- 모듈이 최신 docstring 스타일 가이드를 준수하도록 모듈 편집 순서를 마무리합니다.
문서화 기간(2020년 9월 14일~2020년 11월 30일) :
매주 달성할 목표를 설정합니다. 일주일에 한 개 이상의 모듈 또는 하위 모듈의 docstring 업데이트를 완료하는 것이 좋습니다.
이 모든 모듈에서 누락된 섹션을 추가하고 최신 스타일 가이드에 따라 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일):홀로노믹 :운영 하위 모듈
7주 차 (10월 30일~11월 7일) : 적분 모듈(integrals.integrals), Meijer G-Functions를 사용한 적분 계산
8주 차 (11월 8일~11월 15일) : 물리학, 카테고리 모듈 마지막 부분의 함수, 코드 생성 모듈, 하위 모듈 특집
9주 차 (11월 16일~11월 23일) : 물리학, 카테고리 모듈 마지막 부분의 함수, 코드 생성 모듈, 하위 모듈 특별
10주 차 (11월 24일 - 11월 30일) : 잘못된 점과 함정 섹션
2020년 11월 30일~12월 5일 18:00(UTC): 최종 프로젝트 제출 및 보고서 작성
2020년 12월 3일~10일 18:00(UTC): 프로젝트 성공 및 멘토와의 협업 경험 제출
여기에 언급된 모듈의 순서는 멘토와 자세히 논의한 후 변경할 수 있습니다.
멘토가 제안한 대로 업데이트가 더 쉬운 모듈을 먼저 업데이트하고 복잡한 모듈로 넘어갈 것입니다.
내가 이 프로젝트에 적합한 담당자인 이유는 무엇인가요?
저는 컴퓨터 공학에서 기술 글쓰기를 경험한 적이 있고 git와 github에 정통하기 때문에 이 프로젝트에 적합한 담당자라고 생각합니다.
성공적으로 병합된 sympy의 최신 스타일 가이드에 대한 문서를 업데이트하기 위해 PR을 제출했으므로 워크플로에 확신을 가지고 정기적으로 기여할 수 있습니다.
처음에 자막 제공을 시작했을 때 몇 가지 오류가 발생했습니다. 마침내 변경사항을 커밋하기 전에 매번 테스트를 실행하고 문서를 빌드하는 데 익숙해졌습니다. 그것이 매우 중요하기 때문입니다.
본인은 이 프로젝트에 참여하는 데 매우 편안함을 느끼고 있으며 기대하고 있습니다.