trentm / trentm/python-markdown2
Emacs style extras comment not working as expected
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.8k
- Forks
- 459
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 4
Description
Hello, the documentation here:
https://github.com/trentm/python-markdown2/wiki/Extras
Indicates you can embed which extras you would like enabled in a comment. I've tried that verbatim and it doesn't seem to work for me. After looking in the code, it appears to me (not an expert by any means) that it also wants to see the emacs tokens '-*-' before and after the comment. I also tried that, to no avail.
Finally, the help indicates that "use-file-vars: Look for an Emacs-style markdown-extras file variable to turn
on Extras." might be necessary although the code seems to not use it. I tried for fun, but still nothing.
Some clarification would be greatly appreciated, I like the idea of this feature so I can stop trying to remember "how did I process this particular file?" and just embed it.
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
Compare the wiki's Emacs-style extras example with the parser code and the help text for the "use-file-vars" option. Determine the supported syntax and whether the implementation or documentation is incorrect, then update the relevant documentation so the example works or clearly explains the required behavior.
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
- Mostly clear
- Newbie friendliness
- 45/100