Skip to content

메인페이지와 docs 인트로에 실제 함수기능과 상이한 내용이 들어가있음 #2

Description

@junyeong0619

Issue Description

개요 (Summary)
현재 문서(docs/intro.md, README.md)와 메인 페이지(src/pages/index.js)에 기재된 @vectorize 데코레이터의 사용 예제가 실제 구현된 코드와 일치하지 않습니다. 더 이상 사용되지 않거나 이름이 변경된 속성들이 포함되어 있어, 처음 접하는 사용자에게 혼동을 줄 수 있습니다.

문제점 (Current Behavior)
문서 상의 예제 코드에 실제 구현(src/vectorwave/core/decorator.py)이나 테스트 코드(test_ex/semantic_filter.py)에 존재하지 않는 파라미터가 사용되고 있습니다.

  • 잘못된 속성: replay=True, sequence_narrative, team, priority
  • 누락된 핵심 기능: capture_inputs, semantic_cache, semantic_cache_scope

수정 목표 (Expected Behavior)
test_ex/ 디렉토리 내의 실제 작동하는 테스트 코드를 기준으로 예제 코드를 업데이트해야 합니다.

변경 예시 (Example)

  • AS-IS (변경 전):
@vectorize(
    search_description="Summary of what the function does",
    sequence_narrative="Contextual explanation...",
    team="backend",  # 존재하지 않는 속성
    priority=1,      # 존재하지 않는 속성
    replay=True      # -> capture_inputs=True 로 변경 필요
)
def my_function(arg1): ...
  • TO-BE (변경 후):
@vectorize(
    # 핵심 기능 1: 시맨틱 캐싱
    semantic_cache=True,
    cache_threshold=0.85,

    # 핵심 기능 2: 리플레이를 위한 입력값 자동 캡처
    capture_inputs=True,

    # 선택 사항: 자동 문서화
    auto=True
)
def my_function(arg1): ...

작업 목록 (Task List)

  • docs/intro.md (Introduction 페이지) 예제 코드 수정
  • src/pages/index.js (랜딩 페이지 Hero 섹션) 코드 블록 수정
  • README.md (GitHub 메인) 예제 코드 동기화
  • (옵션) docs/core_concepts.mdsemantic_cache_scope 관련 내용 추가 (Isolation 기능 설명)

참고 자료 (References)

  • 실제 구현 및 테스트 코드: test_ex/semantic_filter.py

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions