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