• Icon: Suggestion Suggestion
    • Resolution: Fixed
    • None
    • None
    • None
    • We collect Bitbucket feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      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

            I see +1

            Ronny Hanssen added a comment - I see +1

            Roger Barnes (Inactive) added a comment - - edited

            Hi Ronny, I'm afraid that's a rather larger issue that I'd dearly like to see resolved so that it is uniform as you suggest. The entire markup syntax on JIRA is different - wiki markup, not Markdown.

            Roger Barnes (Inactive) added a comment - - edited Hi Ronny, I'm afraid that's a rather larger issue that I'd dearly like to see resolved so that it is uniform as you suggest. The entire markup syntax on JIRA is different - wiki markup, not Markdown.

            I hear you, but, the behaviour is different in Jira. There it actually does show the backslash - as expected.
            Isn't it preferable if the behaviour of comments are uniform in the Atlassian suite of products?

            Ronny Hanssen added a comment - I hear you, but, the behaviour is different in Jira. There it actually does show the backslash - as expected. Isn't it preferable if the behaviour of comments are uniform in the Atlassian suite of products?

            Hi Ronny,

            Thanks for the explanation of your use case. You're right that a backslash before a period does trigger the escaping behaviour.

            Since the backslash escape is part of the Markdown specification implemented by the library we use, and I suspect many users would expect it to work the way it does already, I'm afraid this isn't something we're going to change.

            I have updated our documentation, however, to better reflect the existence and behaviour of this Markdown feature.

            Roger Barnes (Inactive) added a comment - Hi Ronny, Thanks for the explanation of your use case. You're right that a backslash before a period does trigger the escaping behaviour. Since the backslash escape is part of the Markdown specification implemented by the library we use, and I suspect many users would expect it to work the way it does already, I'm afraid this isn't something we're going to change. I have updated our documentation, however, to better reflect the existence and behaviour of this Markdown feature.

            Yes. One of my colleagues tried to write

            I have the impression that ..\.. could work somewhat better than .... in the hint path

            The results shown was:

            I have the impression that .... could work somewhat better than .... in the hint path

            In other words, the meaning was totally lost...

            Ronny Hanssen added a comment - Yes. One of my colleagues tried to write I have the impression that ..\.. could work somewhat better than .... in the hint path The results shown was: I have the impression that .... could work somewhat better than .... in the hint path In other words, the meaning was totally lost...

            Hi Ronny,

            The markdown parser only takes backslash as an escape character before certain special characters. For example, I was able to type "C:\TEMP" (on Stash 3.3) and have the backslash render as intended.

            Could you clarify your use case here?

            Roger Barnes (Inactive) added a comment - Hi Ronny, The markdown parser only takes backslash as an escape character before certain special characters. For example, I was able to type "C:\TEMP" (on Stash 3.3) and have the backslash render as intended. Could you clarify your use case here?

            I just realised that Jira handles backslashes in both the Description field and the comment as expected.

            Seeing that makes me think that perhaps Stash should align to the Jira practice?

            Ronny Hanssen added a comment - I just realised that Jira handles backslashes in both the Description field and the comment as expected. Seeing that makes me think that perhaps Stash should align to the Jira practice?

              Unassigned Unassigned
              58d4831fa6ad Ronny Hanssen
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: