SymPy 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:

SymPy

기술 문서 작성자:

lglattly

프로젝트 이름:

docstring의 일관성

프로젝트 길이:

표준 기간 (3개월)

Project description

이 프로젝트에서는 SymPy의 문서 문자열을 더 일관되게 만드는 것을 목표로 합니다.

멘토와 함께 일하면서 먼저 코드베이스의 docstring에 원하는 형식을 식별했습니다. 그런 다음 코드베이스 전체의 모든 문자열 문서에 따라야 할 문서 형식 가이드를 만듭니다. 프로젝트에서 맡은 업무는 기존 문서 주석을 업데이트하기 위한 새 가이드를 구현하는 동시에 언어 사용이나 용어와 같은 다른 불일치를 수집하고 해결하는 것입니다. 제 멘토와 제가 함께 편집상의 일관성 없는 부분에 대한 결정을 내리면 스타일 환경설정도 가이드에 추가됩니다.

이 프로젝트의 최종 목표는 개발자와 참여자 모두가 지금과 앞으로 SymPy의 문서에서 일관성을 유지하는 데 사용할 수 있는 문서 형식 지정 및 스타일 가이드입니다.