micropython / micropython/micropython-lib
Replace triple quotes with actual comments
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.9k
- Forks
- 1.1k
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 3
Description
In many places in these libraries, there are huge "block comments" in the form of triple quotes, which cause memory issues, as Micropython tries to allocate them as a continuous block on the heap. These should be replaced with the proper python comment style.
Contributor guide
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
Search the library files in this repository for large triple-quoted blocks used as comments, then review each occurrence in context. Replace those comment blocks with Python comment syntax and verify that the affected libraries no longer require MicroPython to allocate them as continuous heap blocks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- embedded-iot
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100