• Fizz@lemmy.nz
    link
    fedilink
    arrow-up
    109
    ·
    1 year ago

    No matter how many times I read this I have no idea what’s going on. Can someone explain this like I’m 3

    • Prismey@sh.itjust.works
      link
      fedilink
      arrow-up
      180
      ·
      1 year ago

      A girl read documentation and see that all the titles are underlined with -, but one of the letter isn’t underlined like the others (that’s the lonely s). Then she asks the person doing the commit to fix it and they fix it together.

    • MJBrune@beehaw.org
      link
      fedilink
      arrow-up
      66
      ·
      1 year ago

      So in the documentation they had

      1.9 Ext4 file system parameters
      ------------------------------
      

      As you can see the ‘s’ doesn’t get a ‘-’ under it. So they changed the documentation to:

      1.9 Ext4 file system parameters
      -------------------------------
      

      so the ‘s’ in parameters gets a dash under it.

      this seems to be the standard as everywhere else the dashes go for the same length of characters as the above line. Example:

      2.0 /proc/consoles
      ------------------
      

      The little girl said the ‘s’ in parameters is sad because it didn’t get the dash under it and it was all alone. So they added the dash.

    • jsveiga@sh.itjust.works
      link
      fedilink
      arrow-up
      20
      ·
      edit-2
      1 year ago

      See the first red box in the documentation text? The underline dashes don’t go up to the last letter (s).

      4 year old girl said the “s” was sad because of that, uncle submitted a patch to fix that, and it was accepted.

    • Infamousblt [any]@hexbear.net
      link
      fedilink
      English
      arrow-up
      17
      ·
      edit-2
      1 year ago

      The line of code (well, documentation in the code) used to look like something like this (I’m not sure if this formatting will work on mobile, sorry):

      The code ends with an s

      ----------------------

      And after her changes it looks like this:

      The code ends with an s

      ------------------------

      See how I added an extra - in that second line? That makes the S happier because now it also has a - below it like all the other letters. This also just generally makes that line more consistent with other spots in the code. So it’s not a bad change. It doesn’t do anything really but making your code format nice, easy to read, and consistent is usually important in programming so although it doesn’t do anything tangible it’s still a valuable change!

    • fubo@lemmy.world
      link
      fedilink
      arrow-up
      7
      ·
      1 year ago

      She spotted that there was a missing - in the underline for a heading in a piece of documentation, and her parent helped her submit a fix.

    • redawl@sh.itjust.works
      link
      fedilink
      arrow-up
      6
      ·
      1 year ago

      The first red box shows that the dotted line underneith the text doesn’t go all the way to the s in the text above. In the other red box, the dotted line goes all the way.

      The neice submitted a patch to add the missing line.