Please use single or double quotes in 'bzr help'

Bug #379387 reported by Jari Aalto
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Bazaar
Triaged
Medium
Unassigned

Bug Description

EXAMPLE

$ bzr help current-formats

  ....
  See ``bzr help current-formats`` for the complete list of
  currently supported formats. See ``bzr help other-formats`` for
  descriptions of any available experimental and deprecated formats.

SUGGESTION

In regions outside of US, the use of backticks is quite unfamiliar. It is also not very convient to copy text with mouse drag event because the backtics could be mistakenly copied with it. The backtics cause trouble on shell command line.

Please consider changing the double backticks to plain single or double quotes in all help texts. An example:

  See "bzr help current-formats" for the complete list of
  currently supported formats. See "bzr help other-formats" for
  descriptions of any available experimental and deprecated formats.

Revision history for this message
John A Meinel (jameinel) wrote :

The reason we use back-ticks is because it is ReST format, so that we can do things like "generate HTML" from the strings.

It may be reasonable to have a formatting filter that turns ``foo`` => "foo"

I'll also mention that we have another explicit documentation discussion, that we should use double quotes (") for documentation, because bzr commit -m 'foo bar' doesn't work on Windows (cmd.exe doesn't consider single quote (') to be a quoting character passing the strings as a single parameter.)

Changed in bzr:
importance: Undecided → Medium
status: New → Triaged
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.