pymc-devs / pymc-devs/pytensor
Issue template doesn't render details tags properly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 644
- Forks
- 208
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 16
Description
Description
I just opened #152 using the bug report issue template. The problem is that the "reproducible code example" and "error message" text areas are rendered as python code. So the details tags are naturally completely ignored. I think that these text areas should be regular markdown, and start with a value, not a placeholder. The placeholder disappears immediately once you start typing, but the value will stay as part of the markdown. We could add the <details> tags there, with the relevant python markdown brackets in there.
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
Start by comparing the bug report issue template with the rendering shown in issue #152, focusing on the reproducible code example and error message fields. The work is done when those fields render as regular markdown with details tags and retain their value text while users type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100