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!
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.
No matter how many times I read this I have no idea what’s going on. Can someone explain this like I’m 3
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!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.