kamiazya/scopes

Update API documentation to match actual implementation

Offen

#136 geöffnet am 31.08.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Kotlin (3 Forks)auto 404
good first issuehacktoberfest

Repository-Metriken

Stars
 (2 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Aktualisieren Sie die Dokumentationsdatei, um die tatsächlichen Enum Werte aus der Quelldatei widerzuspiegeln.
Tech Stack
kotlin
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90