Skip to content

docs(bok): Replace boilerplate docstrings with detailed API documentation (#289)#297

Merged
yeongseon merged 1 commit into
mainfrom
docs/issue-289-bok-docstring
Jul 3, 2026
Merged

docs(bok): Replace boilerplate docstrings with detailed API documentation (#289)#297
yeongseon merged 1 commit into
mainfrom
docs/issue-289-bok-docstring

Conversation

@yeongseon

Copy link
Copy Markdown
Owner

Summary

Closes #289

모든 BokAdapter 메서드의 무의미한 boilerplate docstring을 실제 동작 기반 한국어 문서로 전면 교체했습니다.

Changes

  • src/kpubdata/providers/bok/adapter.py의 모든 public/private 메서드 docstring 업데이트
  • 각 메서드가 호출하는 BOK ECOS API 엔드포인트 명시
  • 매개변수, 반환값, 예외 상황 상세 설명 추가
  • ECOS API 호출 형식 (frequency, start_date, end_date 등) 문서화

Quality Gate

  • uv run ruff check . - passed
  • uv run ruff format --check . - passed
  • uv run mypy src - passed
  • uv run pytest - 1009 passed

Example

Before:

def query_records(self, dataset: DatasetRef, query: Query) -> RecordBatch:
    """records을 수행한다."""

After:

def query_records(self, dataset: DatasetRef, query: Query) -> RecordBatch:
    """BOK ECOS API를 호출하여 레코드를 조회한다.

    매개변수:
        dataset: 대상 데이터셋.
        query: 조회 쿼리. start_date, end_date 필수. 주기(frequency)는 선택.

    반환값:
        RecordBatch. items에 조회된 레코드, total_count와 next_page 포함.

    예외:
        InvalidRequestError: start_date 또는 end_date 누락 시.
        AuthError: API 키 인증 실패 시.
        RateLimitError: 호출 한도 초과 시.
        ServiceUnavailableError: BOK ECOS 서비스 점검 중일 때.
    """

…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>
@yeongseon yeongseon force-pushed the docs/issue-289-bok-docstring branch from 4d27dea to 0ee77fb Compare July 3, 2026 23:33
@yeongseon yeongseon merged commit d73c827 into main Jul 3, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[K-007][P3] bok/adapter.py: AI-generated boilerplate docstring 정리

1 participant