kamiazya/scopes

Update API documentation to match actual implementation

Aberta

#136 aberto em 31 de ago. de 2025

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Kotlin (3 forks)auto 404
good first issuehacktoberfest

Métricas do repositório

Stars
 (2 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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

Guia do colaborador

Direção de pesquisa
Atualize o arquivo de documentação para refletir os valores reais da enumeração do arquivo de origem.
Pilha de tecnologia
kotlin
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90