kamiazya/scopes

Update API documentation to match actual implementation

Aperta

#136 aperta il 31 ago 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Kotlin (3 fork)auto 404
good first issuehacktoberfest

Metriche repository

Star
 (2 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Aggiorna il file di documentazione per riflettere i valori effettivi dell'enumerazione dal file sorgente.
Tech stack
kotlin
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90