UCL / UCL/rsd-engineeringcourse
Document image handling code in nbmerge.py
Open
Nobody has claimed this yet.
build
- Dominant language
- Python
- Stars
- 133
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
As far as I can see, this needs:
- an svg to be in a cell by itself, or at least with no other images or
[...](...)markdown in the cell - [other requirements I am missing]
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 reading nbmerge.py and trace its image-handling behavior. Identify the requirements for SVGs, other images, and markdown links, then document those rules and any additional requirements found in the code. The issue does not specify where the documentation should be added.
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
- Needs clarification
- Newbie friendliness
- 35/100