-
Suggestion
-
Resolution: Fixed
-
None
-
None
-
None
In comments made in PRs we often refer to files in our projects (naturally enough). Since we are a Windows shop the path to those files normally does contain backslashes. In the Stash comments (and even in other Atlassian products this also seems to be true (only tested in Jira).
In the markdown docs there is no mention that backslash is an escape character. The simple solution would be to add documentation for this. I would however strongly advise against that. file-paths are very common in these comments and the Windows user base is significant (I would guess).
The better solution, IMHO, would be to either:
1. Remove escape option (undocumented feature already = "no" harm done...)
2. Make another character the escape character (i.e. use a character that is much rarer to control this)
3. Make the escape character configurable (default is \ for backwards compatibility). We, as a Windows shop, could then change this to i.e. ¤.
[BSERV-5332] Backslash escapes for Markdown should be documented
Workflow | Original: JAC Suggestion Workflow [ 3395875 ] | New: JAC Suggestion Workflow 3 [ 3617759 ] |
Status | Original: RESOLVED [ 5 ] | New: Closed [ 6 ] |
Workflow | Original: BSERV Suggestions Workflow [ 2686150 ] | New: JAC Suggestion Workflow [ 3395875 ] |
Workflow | Original: Stash Workflow [ 734007 ] | New: BSERV Suggestions Workflow [ 2686150 ] |
Status | Original: Closed [ 6 ] | New: Resolved [ 5 ] |
Resolution | New: Fixed [ 1 ] | |
Status | Original: Needs Triage [ 10030 ] | New: Closed [ 6 ] |
Summary | Original: Backslash in PR comments should not be interpreted as escape-characters | New: Backslash escapes for Markdown should be documented |
Summary | Original: Backslash in PR comments are considered escape-character | New: Backslash in PR comments should not be interpreted as escape-characters |