RunestoneInteractive / RunestoneInteractive/java4python
Import could be its own subsection and not after defining data types
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Description
Reading through section 3.1.1, I felt that I jumped from one topic to another very quickly. I understand that they are going through a block of Java code and explaining it, but it just felt confusing to me.
Screenshot
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating section 3.1.1 in the book source and read the surrounding explanation of the Java block. Separate the import discussion into its own subsection or otherwise reorder the material so the progression is easier to follow, then review the rendered section against the reported screenshot context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100