Skip to content

developer docs "copy" should copy a usable command #3430

@bhaller

Description

@bhaller

Next in my journey to do a tskit PR. I'm now at https://tskit.dev/tskit/docs/stable/development.html#git-workflow and am trying to set up my repo. It says:

Make sure that your local repository has been configured with an [upstream remote](https://help.github.com/articles/configuring-a-remote-for-a-fork/):

$ git remote add upstream https://github.com/tskit-dev/tskit.git

That last line is inside a box that has a "copy" button. If I use that button, I get this on my clipboard:

$ git remote add upstream https://github.com/tskit-dev/tskit.git

Pasting that into my terminal gives an error:

bhaller@glass % $ git remote add upstream https://github.com/tskit-dev/tskit.git
zsh: command not found: $

Obviously I just need to leave out the $. But what gets copied shouldn't include the $ character in the first place; it isn't particularly useful to put something onto the user's clipboard that is not, in fact, usable. :-> Presumably this issue applies across lots of other places in the doc too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions