LaravelDaily / laravel-invoices

Laravel package to generate PDF invoices from various customizable parameters
GNU General Public License v3.0
1.39k stars 303 forks source link

Copy to clipboard from the doc includes a $ sign #229

Closed rabol closed 6 months ago

rabol commented 6 months ago

When you try to copy composer or artisan command from the documentation: https://github.com/LaravelDaily/laravel-invoices

it will include the $ signe which makes the command invalid when pasting into your terminal / command prompt

ModestasV commented 6 months ago

There are multiple things, as of why this might be needed. For example:

This indicates that you are expected to run this in the terminal You are not alone in noticing this, but it is very common. There is a clear indication as to where things happen. You can read a few discussions like this: https://meta.askubuntu.com/questions/14841/why-do-people-prefix-code-examples-with-dollar-sign

This indicates if this is a sudo or a normal user command Another great use case of this - you can quickly spot if you will need sudo or not. If you don't, it will be a $, but if you do, it will be #

Improves security Just a reminder that you shouldn't copy-paste commands from the internet. https://www.makeuseof.com/why-you-shouldnt-copy-paste-commands-from-internet/#:~:text=However%2C%20you%20should%20be%20aware,commands%20behind%20harmless%2Dlooking%20code.


Besides these reasons why we might have added them, you are more than welcome to submit a PR to fix this. But for now, we will not change anything.

Thanks, and happy invoicing!

rabol commented 6 months ago

Not sure why you don't want to fix this: just exclude the $ signe and it will work

ModestasV commented 6 months ago

@rabol Sorry, have you read my comment on reasons why?

mc0de commented 6 months ago

@rabol just delete the $ symbol and try to be more polite and less insisting with people online