graphql-python / graphql-python/graphene-sqlalchemy

Expand docs with batching example

Aberta
#387 0 comentários 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Python
Estrelas
985
Forks
223
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

Add a short doc on the use of `BatchSQLAlchemyConnectionField` with a brief comment. It's only documented in the test files, but should also be included in the documentation.

Additionally, can expand docs on `sort` keyword to include disabling and custom usage.

_Originally posted by @palisadoes in https://github.com/graphql-python/graphene-sqlalchemy/issues/357#issuecomment-1447481010_

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece localizando os arquivos de teste que documentam BatchSQLAlchemyConnectionField e a documentação existente sobre a palavra-chave sort. Adicione um exemplo curto de batching com um comentário breve e, em seguida, documente como desabilitar sort e como usar uma ordenação personalizada. O trabalho estará concluído quando ambos os tópicos estiverem cobertos na documentação do projeto e as verificações de documentação relevantes forem aprovadas.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python, sqlalchemy
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.