RunestoneInteractive / RunestoneInteractive/java4python
Indexing needs improvement throughout
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Indices should:
- Serve as a reference for all important concepts and code terminology.
- All code such as
whileshould be placed in the index as<idx><c>while</c></idx>. Of course, you cannot see anything that is between<idx>tags, so indexing is best done at the beginning of a sentence or paragraph. - ONLY be capitalized if a proper noun or an acronym or code that must be capitalized. e.g. object-oriented programming should NOT be capitalized in the index
- Acronyms should appear in the index separately from what they stand for. e.g., OOP and object-oriented programming should be indexed separately.
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
No file or test is named. Start by locating the book's index source and existing uses of the tags, then review how concepts, code terms, capitalization, and acronyms are currently indexed. Done means the index follows all four stated rules throughout the book.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100