harshraj22 / harshraj22/rl_lab
Documentation
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/harshraj22/rl_lab/blob/a97e10df1a3a9588337119d814d2d6364107bd3f/lab3/data_loader/environments.py#L68
https://github.com/harshraj22/rl_lab/blob/a97e10df1a3a9588337119d814d2d6364107bd3f/lab3/data_loader/environments.py#L60
by looking at the code, it is not very clear, why to add/ subtract 1 from 9. Kind of magic number and magic operation.
Add better documentation
Contributor guide
No contributing guide indexed for this repository
Research direction
Start in lab3/data_loader/environments.py at lines 60 and 68, and trace the surrounding calculation to understand why 1 is added or subtracted from 9. Document the purpose of those values and operations in the code so the reasoning is clear to future readers; no test or validation command is mentioned.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100