Checking a Checkbox In Issue Results in Bad Error Message and Blocking
Summary
When a numbered bullet checkbox contains somewhat standard formatting syntax (yes, there is no standard markdown/common mark for this element), checking it causes an error that is completely misleading. Since the format creating the error is both: 1) natural to someone attempting to create numbered checkboxes and 2) the only way to create numbered bullets on GitHub and in the client utility "Typora" - I feel the syntax should be supported. However, it should not generate an inaccurate error if the syntax is not going to be supported.
Steps to reproduce
- Create an issue with these contents:
- [x] Checkbox 1
1. [x] Checkbox 2
2. - [ ] Checkbox 3
- Check each one in succession.
- Upon checking the third box, observe the incorrect error about the description being edited at the same time as your edit.
- Put the same markdown in a Github issue (and/or Typora) - note that only the third option renders as a numbered checkbox item. I assume this is because both
-and1.are treated as the bullet indicator that must proceed[ ]to create the complete syntax for a checkbox and so rendering1. [ ]renders an unnumbered checkbox just as it does not render the-when rendering- [ ](unordered checkbox)?
Example Project
https://gitlab.com/happyspring/SpringFever100/issues/3
What is the current bug behavior?
Inaccurate error upon checking a numbered checkbox item that is formatted with reasonable markdown.
What is the expected correct behavior?
Save the checkbox state with no error (allow the alternative markdown syntax).
Relevant logs and/or screenshots
Output of checks
This bug happens on GitLab.com as of today.
Possible fixes
Simply allow the following syntax for numbered checkboxes when the code for processing the act of checking / unchecking runs:
1. - [ ] Fix Checkboxes on GitLab :)
I came upon this when writing part 2 of a blog article on using Checklists in Markdown for DevOps and comparing functionality and markdown requirements.
