alexmojaki / alexmojaki/futurecoder

Error handling, spots for docstrings and differentiating 'message' and 'messages' variables in question_wizard.py

Aperta
#446 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
1.5k
Fork
183
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### Enhancements for code clarity and consistency within the Python files

## Details

1. **Error handling messages**
- SyntaxError in function, 'wrapped_callback' could use a detailed error message for better clarity
![image](https://github.com/alexmojaki/futurecoder/assets/139836037/e08deef5-e989-4a4c-aaff-288abc22a53d)
- ValueError in function input_callback could use a detailed error message for better clarity
![image](https://github.com/alexmojaki/futurecoder/assets/139836037/8e0bd7a5-f9dd-4747-ba31-9d86772f2c31)

2. **Docstrings for Python codes**
- The functions throughout the Python files could use docstrings for a better understanding of the code.

3. **Variable naming consistency in question_wizard.py**
- In the question_wizard_check function, we have both 'messages' and 'message' as variables. Ensure consistency in variable names to avoid confusion.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.