trentm / trentm/python-markdown2
Suggestion: Comments extra
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.8k
- Forks
- 459
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 4
Description
(Forgive me if one isn't supposed to put suggestions in issues. Also, forgive me if the metadata extra does this. I thought it did at first but it confused me in such a way that I'm pretty sure it doesn't.)
I suggest a new extra, comments. When used, text surrounded by ~'s then only exists in the output HTML file as being within an HTML comment. You know, <!-- these guys? -->.
Perhaps if there are two tildes surrounding the text then it is removed from the output completely. Like comments for C source code.
Thanks for reading.
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 reviewing the existing metadata extra, since the issue compares the proposed behavior with it. Determine whether the requested syntax should emit HTML comments or remove text entirely, then add the extra and tests covering both forms; done means the generated HTML matches the selected comment behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- content
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100