docs(bok): Replace boilerplate docstrings with detailed API documentation (#289)#297
Merged
Merged
Conversation
…tion Replace all generic 'BokAdapter과 관련된 값을 계산하거나 조회한다' docstrings with specific Korean documentation describing actual BOK ECOS API behavior, parameters, return values, and exceptions. Each method now clearly documents which ECOS endpoint it calls and what data it processes. Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
4d27dea to
0ee77fb
Compare
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
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.
Summary
Closes #289
모든
BokAdapter메서드의 무의미한 boilerplate docstring을 실제 동작 기반 한국어 문서로 전면 교체했습니다.Changes
src/kpubdata/providers/bok/adapter.py의 모든 public/private 메서드 docstring 업데이트Quality Gate
uv run ruff check .- passeduv run ruff format --check .- passeduv run mypy src- passeduv run pytest- 1009 passedExample
Before:
After: