search

CocoaPods / search.cocoapods.org

This is the CocoaPods search engine repo, please direct CocoaPods issues to the main CocoaPods repository.
25 stars 11 forks source link

Removes square brackets around [sudo] in install instructions; replaces with comment #37

Closed MaxGabriel closed 10 years ago

MaxGabriel commented 11 years ago

So far I've seen three times where someone leaves in the square brackets around [sudo] in the instructions. This morning's closed issue, once when watching a designer install Cocoapods, and once when I was installing it on a new computer.

To solve this, I changed it from $ [sudo] gem install cocoapods to

$ gem install cocoapods # You may need: sudo gem install cocoapods

Testing: If you merge this, this would be the longest preformatted text on the page, but it didn't extend past the page on an iPhone 4 (portrait) or on my Macbook pro. It's possible it would extend past the page on even smaller phones, in which case maybe I should enable text wrapping in the pre section of the SCSS?

floere commented 11 years ago

Hi Max,

Brackets are widely used to designate an option, for example in command line usage descriptions, for example when you enter man ls. Reference: http://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_Form#Table_of_symbols

Cheers, Florian

orta commented 10 years ago

Closing, I think this is a valid point though. We've addressed it a bit differently in the guide and may do so in the new homepage.