ImperialCollegeLondon / ImperialCollegeLondon/ReCoDE-PythonGUI

Feedback Day 1

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

#### Lesson material

- [x] Add link to Dearpygui documentation when talking about it in the first paragraph.
- [x] I would organise the information in the `Structure of Dearpygui` section slightly differently, first showing the snippet of the code and then, in subsections (Setup, Context, etc.), explaining what each of those commands do. At the moment, there is some disconnection between the different parts of the section.
- [x] The code within the code blocks seems to be indented - it should be unindented (following normal python indent) so readers can copy and use that code straight away.
- [x] Anaconda is totally fine, but it is not the only option and some readers might have already a different python distribution installed. Rather than stating categorically that `it is the recomended option`, just indicate that you will be using Anaconda Python and their virtual environemnt.
- [x] Talking about virtual environments, many people is not familiar with them. I would include a link to a tutorial about that topic.
- [x] Python 3.9 is fine, but it is already 2.5 years old. I'd suggest to work with a newer version of Python (dearpygui supports all versions from 3.7)

#### Code

All good - nice and clear explanations online (although I personally find a bit obscure why the radio buttons appear side by side with the checkboxes rather than in a new line). If anything:

- [x] Explain what a context manager is (`with...`) given that they are used extensively.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the lesson material and code sections named in the issue, especially the first paragraph, Structure of Dearpygui, code blocks, virtual environments, and the examples using `with`. No files or tests are named; completion is reflected by the checked checklist, so confirm that each listed documentation change is present.

Written by the indexing model from the issue text.

Assessment

Tech stack
anaconda, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.