Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Config file undocumented?

Aberta
#3,208 8 comentários 3 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

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

Direção de pesquisa

Start by comparing the configuration file options with the options shown by codespell --help, focusing on whether each command-line option has a config equivalent and what values it accepts. Check how count and check-hidden are handled, then document the supported config syntax and verify that the examples work; the issue does not name any files or tests.

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

Descrição

I might have missed it but it seems to me that the config file is nearly undocumented.

I can see all (?) possible config options via codespell --help. But these are for the command line. It is not clear if this options do have an equivalent in the config file and what values they should have.

For example it seems that I can do count = True in the config file. But from reading --help it was not clear that True is the correct value.
Or --check-hidden is totally unclear. It works on command line but when I do check-hidden = True I got codespell: error: unrecognized arguments: True. So I don't know how to configure check-hidden via config file.

Linguagem predominante
Python
Estrelas
2.4k
Forks
531
Merge médio
15h 5min
PRs com merge (30d)
18

Preparar o ambiente

Abrir no Codespaces

Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.

  • Sem Dockerfile nem arquivo Docker Compose
  • Sem modelo de pull request
  • Sem guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de codespell-project/codespell

Todas as issues de codespell-project/codespell

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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