Allow doctest in the comments.
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 218
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
Some times it's useful to explain implementation details of the function with usage examples in the comment.
I propose to allow doctest prefixed code in the comments.
What do you think?
Have a good day 🎉
Best regards,
Artem.
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 files, tests, or entry points are named. Start by examining how the tool identifies commented-out Python code, then clarify which doctest-prefixed comments must be preserved and how they should be distinguished from removable code. Done means the agreed doctest behavior is implemented and covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100