Programming

17748 readers

615 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 2 years ago

MODERATORS

[email protected]

197

Pointers for writing software tutorials (refactoringenglish.com)

submitted 2 days ago* (last edited 2 days ago) by [email protected] to c/[email protected]

32 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 13 points 2 days ago* (last edited 2 days ago) (1 children)

I absolutely abhor it when the command includes $ that copies with it. It means nothing to the beginner's and the pros know it is a command.

I wrote under other comment:

yeah, I'd give it as 4 separate copy-pastable commands and then write "or as one command..."

[–] [email protected] 6 points 2 days ago

Yeah, it should not be part of the text just like line numbers shouldn't be part of the code on a code hosting site, yet it can be visible, no? Later it does recommend using $ to distinguish command and output. Is it now okay for a beginner to be confused about what it means?