kamiazya/scopes

Update API documentation to match actual implementation

Ouverte

#136 ouverte le 31 août 2025

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Kotlin (3 forks)auto 404
good first issuehacktoberfest

Métriques du dépôt

Stars
 (2 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Mettez à jour le fichier de documentation pour refléter les valeurs réelles de l'énumération à partir du fichier source.
Stack technique
kotlin
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90