crickets-and-comb/shared

Remove common noqas.

Open

#41 aperta il 25 mar 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Makefile (0 fork)auto 404
bugenhancementhelp wanted

Metriche repository

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

Descrizione

Throughout our codebases, we ignore some common linting errors that are raised due to a mismatch between our formatting tools and our linting tools. Examples include E712 and E203. As a result, we have # noqa: E712 for example spread all over, and we often need to add these noqas to new code.

We should remove the need for these noqas in one of two ways:

  1. Add the class of linting error to the shared config files (usually the flake8 file).
  2. Update our formatting tool to modify the code to meet the standard.
  3. We may no longer need them in the first place due to updates in the meantime, so try first just removing the noqa altogether.

We should then remove the noqas wherever they exist in consuming repos.

In some cases, we may want to always fail to force developers to intentionally seek a solution or ignore it.

Guida contributor

Direzione di ricerca
Identifica tutti i commenti `# noqa` nel codice, specialmente quelli relativi a E712 e E203. Verifica se la regola di linting può essere aggiunta al file di configurazione condiviso di flake8 per ignorarla globalmente. Se possibile, aggiungi la regola alla configurazione e rimuovi i commenti noqa. In alternativa, assicurati che lo strumento di formattazione (es. Black) sia configurato per produrre codice che superi il linting. Testa eseguendo il linter e gli strumenti di formattazione. Se non più necessari, rimuovi semplicemente i commenti noqa e verifica che il linter passi.
Tech stack
python
Dominio
backenddeveloper experience
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70