alexmojaki / alexmojaki/futurecoder

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

Open
#446 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
1.5k
Forks
183
PR merge metrics
No merged PRs in 30d

Description

### 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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.