Use Native File::PATH_SEPARATOR and remove $ before gem env

[parkr]

Address @luislavena's comment: #913 (comment)

/cc @schneems for the awesome patch.

Follow-up to #913.

[schneems]

❤️ I love the file separator idea, had no clue that constant existed. I'm only okay on removing $ but it's my own personal convention http://www.schneems.com/post/60359275700/prepare-do-test-make-your-technical-writing-shine/ 😀 . Either way thanks for helping out 👍

[parkr]

Interesting post! We use it heavily as well over on http://jekyllrb.com. It has always felt weird in command-line tool output, though. Just a personal preference, I suppose. 😄

Cheers! 🍻

[luislavena]

@schneems @parkr perhaps is because I'm not a native english speaker but if you say:

execute gem env for more information.

I understand that I need to execute gem env. if $ is the command prompt, people will attempt to run $ gem env and get this output:

-bash: $: command not found

(and trust me, happens more often that you would admit).

The convention of $ being the command prompt is both UNIX-centric and assumes a lot of background that the end user facing this might not have.

I've seen people with no background on Ruby, Rails or Bundler trying get a site working powered by Jekyll, either Mac or Windows.

[schneems]

I think it would be best to say an action word such as execute and tell them where. So perhaps saying

execute `gem env` in your terminal for more information

Would be good. Otherwise they may think they need to go into irb and execute gem env:

$ irb
girb(main):001:0> gem env
NameError: undefined local variable or method `env' for main:Object
    from (irb):1
    from /Users/schneems/.rubies/ruby-2.1.1/bin/irb:11:in `<main>'

At least if they did this, they may re-visit the wording and realize that terminal is not the same thing as irb.

I choose the word terminal as opposed to prompt or command line or shell but maybe there is some debate here.

[parkr]

Specificity is certainly important. I think where the prefix becomes necessary is when there are multiple lines, e.g.:

$ gem env
$ gem list

The prefix is then used to indicate that those commands are separate, in addition to being shell commands.

I think gem env here is fine, but definitely agree with @schneems that being specific about what to do with this line and where to do it is important:

execute `gem env` in your terminal for more information

[drbrain]

AFAIK the other documentation in rubygems doesn't use $ before commands.

PS: I remember being confused by $ some command long ago when I didn't know what I was doing.