이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- SymPy
- 테크니컬 라이터:
- 짧게
- 프로젝트 이름:
- 문서 문자열 간 일관성
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
이 프로젝트에서는 SymPy의 docstring에 일관성을 더하는 것을 목표로 삼고 있습니다.
멘토와 함께 코드베이스의 문서 문자열에 원하는 형식을 먼저 식별했습니다. 그런 다음 코드베이스의 모든 docstring에 대해 따라야 할 문서 형식 지정 가이드를 만듭니다. 또한 기존 문서 문자열을 업데이트하는 새 가이드를 구현하는 동시에 언어 사용이나 용어와 같은 기타 불일치 사항을 수집하고 해결하는 작업을 수행하려고 합니다. 멘토와 제가 함께 이렇게 더 많은 불일치를 처리할 방법을 편집으로 결정하면 그에 따른 스타일 선호도도 가이드에 추가됩니다.
이 프로젝트의 최종 목표는 개발자와 기여자 모두가 사용할 수 있는 문서 형식 지정 및 스타일 가이드로, 현재와 미래에 SymPy docstring의 일관성을 유지하는 데 도움이 됩니다.