Uploaded image for project: 'Bitbucket Data Center'
  1. Bitbucket Data Center
  2. BSERV-5332

Backslash escapes for Markdown should be documented

    XMLWordPrintable

Details

    • 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.

    Description

      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. ¤.

      Attachments

        Activity

          People

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

            Dates

              Created:
              Updated:
              Resolved: