docs(commands): diff·history 모듈 RustDoc 추가#321
Merged
Conversation
diff.rs, history.rs에 module-level(//!) 및 function-level(///) RustDoc을 추가. 인접한 smartlog.rs·complete.rs와 일관성 맞춤. - diff.rs: //! 모듈 헤더(diff/conflicts/sync 역할·관련 이슈), pub async fn diff/conflicts/sync에 파라미터·출력모드·동작 설명 추가 - history.rs: //! 모듈 헤더(OpLog·ExecLog 구조 설명), pub async fn log/log_export/undo에 동작·edge-case 설명 추가 프로덕션 코드 변경 없음 (주석 전용). Closes #320 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
무엇
src/cli/commands/diff.rs와src/cli/commands/history.rs에 module-level//!및 function-level///RustDoc 추가.왜
smartlog.rs,complete.rs등 인접 모듈은 모두 문서화되어 있으나diff.rs·history.rs는 주석 전무 → 일관성 부재parsec diff,parsec conflicts,parsec sync,parsec log,parsec undo6개 공개 함수가 설명 없이 노출돼 신규 기여자 진입 장벽 높음변경
diff.rs//!모듈 헤더 (3개 커맨드 역할·관련 이슈 참조) +diff·conflicts·sync함수 dochistory.rs//!모듈 헤더 (OpLog/ExecLog 구조 설명) +log·log_export·undo함수 doc프로덕션 코드 변경 없음 — 주석 71줄 추가만.
리스크
없음. 주석 전용 변경.
롤백
브랜치 drop 또는 revert 1 commit.
Test plan
cargo build --quiet✅cargo fmt --check✅cargo clippy -- -D warnings✅ (doc_overindented_list_items 경고 수정 포함)Closes #320
@erishforG 검토 부탁드립니다 🖤