kamiazya/scopes

Update API documentation to match actual implementation

Open

#136 opened on Aug 31, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Kotlin (3 forks)auto 404
good first issuehacktoberfest

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

Background

As identified in PR #110 review, the ComparisonOperator enum values listed in the API documentation do not match the actual implementation.

Problem

  • Documentation shows enum values like EQ, NE
  • Actual implementation uses EQUALS, NOT_EQUALS, etc.
  • This inconsistency can confuse API users

Solution

Update the documentation in docs/reference/api/aspect-api-reference.md to match the actual enum values in contexts/scope-management/application/src/main/kotlin/io/github/kamiazya/scopes/scopemanagement/application/query/AspectQueryAST.kt.

Files Affected

  • docs/reference/api/aspect-api-reference.md

Priority

Low - Documentation fix

Contributor guide

Research direction
Update the documentation file to reflect the actual enum values from the source file.
Tech stack
kotlin
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90