←back to thread

Examples are the best documentation

(rakhim.exotext.com)
401 points Bogdanp | 10 comments | 09 Oct 25 19:34 UTC | HN request time: 0.832s | source | bottom
Show context
voidUpdate ◴[10 Oct 25 07:59 UTC] No.45536377[source]▶
This sort of thing really bugs me when I work with Unity and Unreal. Sometime the documentation for something is just so useless. A lot of the time when trying to understand Unreal nodes, the documentation page is just a picture of the node and the name of the node restated in slightly longer words, as if that helps anything. And so many times when I'm using Unity at £JOB, I just want to know how to use a function properly, and a short example would help so much. It's generally good but some pages just have nothing of value on them. If I could submit my own additions to the Unity docs pages, I would probably end up doing that
replies(2): >>45537676 #>>45538279 #
1. squigz ◴[10 Oct 25 11:32 UTC] No.45537676[source]▶
> £JOB

Wait a second, do people use $ for `$job` because it's how they earn money and not, as I've always thought, used it as a variable name?

Stop throwing my entire world view out of order please.

replies(2): >>45537715 #>>45540205 #
2. voidUpdate ◴[10 Oct 25 11:36 UTC] No.45537715[source]▶
I actually don't know, I just assume the majority of people are americans and that's why they use $. I don't use $ in programming except for string interpolation, so it's never really registered as a variable sigil to me
replies(3): >>45537805 #>>45538992 #>>45539199 #
3. squigz ◴[10 Oct 25 11:46 UTC] No.45537805[source]▶
Oh no my PHPness is showing!

Also, many, many countries use $, like Canada.

replies(1): >>45539064 #
4. zahlman ◴[10 Oct 25 13:46 UTC] No.45538992[source]▶
> I don't use $ in programming except for string interpolation

... but the entire point of the "$JOB" etc. slang is that it's a string interpolation...

replies(1): >>45539293 #
5. tom_ ◴[10 Oct 25 13:52 UTC] No.45539064{3}[source]▶
If you think it would reflect on you better, think of it as indicating regular POSIX shell use?!

(I'm 99% sure it's intended to be reminiscent of that sort of syntax. Example use: https://news.ycombinator.com/item?id=42761939)

6. SAI_Peregrinus ◴[10 Oct 25 14:02 UTC] No.45539199[source]▶
Every time I use $word in a comment is to be reminiscent of POSIX-style string interpolation for some word. The vast majority of cases where I've seen it are such, only if "word" is numeric do I expect $ is used as a currency symbol.
7. voidUpdate ◴[10 Oct 25 14:11 UTC] No.45539293{3}[source]▶
Not how I use it, string interpolation would be $"{job}"
replies(1): >>45540609 #
8. marcosdumay ◴[10 Oct 25 15:40 UTC] No.45540205[source]▶
The $ is for variables. And the upper case make it a BASIC variable, instead of something like Perl or PHP.

Some times people put it in angle brackets <JOB>. I have no idea what system use variables like that.

replies(1): >>45541049 #
9. yjftsjthsd-h ◴[10 Oct 25 16:15 UTC] No.45540609{4}[source]▶
That depends on the language. In unix shell,

  echo $JOB
and

  echo ${JOB}
are identical, though the latter is more flexible (Allowing eg. `echo ${JOB:-unemployment}` or `echo ${JOB}SUCKS`).
10. 1718627440 ◴[10 Oct 25 16:54 UTC] No.45541049[source]▶
Templates use this syntax in some languages.