this post was submitted on 12 Oct 2023
1263 points (98.5% liked)

linuxmemes

20463 readers
508 users here now

I use Arch btw


Sister communities:

Community rules

  1. Follow the site-wide rules and code of conduct
  2. Be civil
  3. Post Linux-related content
  4. No recent reposts

Please report posts and comments that break these rules!

founded 1 year ago
MODERATORS
 
top 50 comments
sorted by: hot top controversial new old
[–] [email protected] 139 points 10 months ago (4 children)

Reminds me of a comment I once came across in a work application's code: "This function took forever to write correctly. It was hard work. I didn't document it. Figure it out."

Of course the variables were not defined properly and were named esoterically.

[–] [email protected] 108 points 10 months ago (1 children)

the variables were not defined properly and were named esoterically

I wonder why it was so hard and took so long to write

[–] [email protected] 31 points 10 months ago (2 children)
[–] [email protected] 11 points 10 months ago

As demonstrated by the variable naming and documentation.

load more comments (1 replies)
[–] [email protected] 12 points 10 months ago

At what point is documenting decompiled code easier?

load more comments (1 replies)
[–] [email protected] 135 points 10 months ago (2 children)
$ mysterytool
$

WHAT DID YOU DO?!

[–] [email protected] 40 points 10 months ago
$ mysterytool -vv
DEBUG: Complete.
$
[–] [email protected] 33 points 10 months ago

Knowing my luck, It probably deleted a rarely used system library and will lead to unpredictable crashes.

[–] [email protected] 100 points 10 months ago* (last edited 10 months ago) (7 children)

I don't understand how devs can be too lazy to write documentation but somehow they'd rather explain the same shit in discord over and over and over and over and over and over

[–] [email protected] 50 points 10 months ago (2 children)

The help command is one of the first things I work on in any project. Even if I'm never gonna share it, my future self will appreciate it.

[–] [email protected] 9 points 10 months ago

Even on simple scripts, it's so help to remind yourself however the hell you made it work.

load more comments (1 replies)
[–] [email protected] 42 points 10 months ago* (last edited 10 months ago) (2 children)

Why is discord so popular in non-gaming circles? People use it as a shitty, bloated and centralized IRC clone, with the voice fuction being completely ignored.

[–] [email protected] 9 points 10 months ago

bc everyone is a gamer, and using another chatting app is just adding more clutter

load more comments (1 replies)
[–] [email protected] 11 points 10 months ago* (last edited 10 months ago) (1 children)

i write poorly documented code on my solo projects because i am lonely

load more comments (1 replies)
[–] [email protected] 11 points 10 months ago (1 children)

Easy: people who still use Discord have brain rot

load more comments (1 replies)
[–] [email protected] 9 points 10 months ago

I think it's loneliness, honestly.

That and corporate work environment tends to rewards those that can explain stuff vocally ad nauseum.

load more comments (2 replies)
[–] [email protected] 82 points 10 months ago* (last edited 10 months ago) (12 children)

I was recently trying trying to get help on a clipboard program someone had recommended me, clipq. What I found instead was a GitHub discussion where the dev said "I'm not sure what you mean by 'man' pages" in response to someone asking for them. I think I need to find an alternative

[–] [email protected] 24 points 10 months ago

Did they at least provide woman pages then?

/s

[–] [email protected] 10 points 10 months ago (1 children)

I've only known about (and always use) xclip.

load more comments (1 replies)
load more comments (10 replies)
[–] [email protected] 64 points 10 months ago* (last edited 10 months ago) (1 children)

Haha, I made this :) Here’s the blog post I created it for, if you want a bit of context:

https://www.tweag.io/blog/2023-10-05-cli-ux-in-topiary/

[–] [email protected] 9 points 10 months ago (1 children)

Correct, I shamelessly stole it!

Also, sorry, I stole it.

load more comments (1 replies)
[–] [email protected] 48 points 10 months ago (2 children)

But also

mysterytool --help
mysterytool: unrecognized option: '-'

ok then...

mysterytool -h
mysterytool: unrecognized option: 'h'

[–] [email protected] 39 points 10 months ago* (last edited 10 months ago) (1 children)
mysterytool --help

   ‘--help’ unrecognized option, -h for help

I will burn this motherfucker to the ground

[–] [email protected] 14 points 10 months ago* (last edited 10 months ago) (3 children)

Or the opposite:

mysterytool -h

     -h unrecognized option, --help for help

Both need to burn.

load more comments (3 replies)
[–] [email protected] 26 points 10 months ago* (last edited 10 months ago) (4 children)

And

mysterytool -h

mysterytool: try our info page that requires a custom viewer because gnu is better than standards. And there is no regular man page because fuck you

load more comments (4 replies)
[–] [email protected] 42 points 10 months ago (7 children)

If the program's author hasn't bothered to properly document its function, then it has no business being on my machine.

[–] [email protected] 29 points 10 months ago (3 children)

"tHe PrOgRaM iS sElF dOcUmEnTiNg"

load more comments (3 replies)
load more comments (6 replies)
[–] [email protected] 32 points 10 months ago

It's like people don't like surprises anymore.

[–] [email protected] 32 points 10 months ago (2 children)
[–] [email protected] 12 points 10 months ago (1 children)
load more comments (1 replies)
load more comments (1 replies)
[–] [email protected] 32 points 10 months ago* (last edited 10 months ago) (10 children)

Programmers generally detest to do documentation, so when the user help "UI" is all down to a programmer to define this is often what you get, especially if it's a small tool.

[–] [email protected] 22 points 10 months ago (1 children)

I never understood that. I'm a programmer and I tend to over-document.

[–] pomodoro_longbreak 16 points 10 months ago

Yeah this is shitty, and if you're a programmer reading this and you agree with it, be better. There is no excuse for under-documenting a CLI.

Even when I'm developing, I write out my usage text first, like -o [json,csv,pretty] specify output format (default 'pretty') [NOT IMPLEMENTED] or the like.

load more comments (8 replies)
[–] [email protected] 27 points 10 months ago

Exclusively installed through some dodgy PPA you got from a blog.

[–] [email protected] 24 points 10 months ago* (last edited 10 months ago)

strings `which mysterytool` | less

Give up your darn secrets before I start fumbling around with strace and get even more frustrated!

[–] [email protected] 22 points 10 months ago

I just want to say this is a masterful use of the format.

[–] [email protected] 14 points 10 months ago (1 children)
[–] [email protected] 34 points 10 months ago (6 children)

-H for Hard drive to delete, -h is help

load more comments (6 replies)
[–] [email protected] 10 points 10 months ago (3 children)
find / -name mysterytool -exec rm {} \;
[–] [email protected] 21 points 10 months ago (1 children)
load more comments (1 replies)
load more comments (2 replies)
[–] [email protected] 10 points 10 months ago
[–] [email protected] 9 points 10 months ago

Quite the mystery!

load more comments
view more: next ›