When someone corrects your code

I am really happy when people are quite strict in code reviews, it makes me feel safer and I get to learn more.

Nothing worse than some silent approvals with no real feedback. What if I missed something obvious... and now it's merged.

To be fair, I also enjoy getting my grammar corrected. I'm juggling 3 languages and things can get messy.

91

In that spirit, I will call attention to your first sentence, specifically the comma. In my opinion, that can be improved. One of three other constructions would be more appropriate:

I am really happy when people are quite strict in code reviews. It makes me feel safer and I get to learn more.

I am really happy when people are quite strict in code reviews, because it makes me feel safer and I get to learn more.

I am really happy when people are quite strict in code reviews; it makes me feel safer and I get to learn more.

The first of my suggested changes is favoured by those who follow the school of thought that argues that written sentences should be kept short and uncomplicated to make processing easier for those less fluent. To me, it sounds choppy or that you've omitted someone asking "Why?" after the first sentence.

Personally, I prefer the middle one, because it is the full expression of a complete state of mind. You have a feeling and a reason for that feeling. There is a sense in which they are inseparable, so not splitting them up seems like a good idea. The "because" explicitly links the feeling and reason.

The semicolon construction was favoured by my grade school teachers in the 1960s, but, as with the first suggestion, it just feels choppy. I tend to overuse semicolons, so I try to go back and either replace them with periods or restructure the sentences to eliminate them. In this particular case, I think the semicolon is preferable to both comma and period, but still inferior to the "because" construction.

I've clearly spent too much time hashing stuff out in writers' groups. :)
33
- This is what I live for. :D
  
  I agree with most of that. In formal settings, I prefer full sentences with conjunctions; however, choppy sentences are the ones that often end up in my Lemmy comments.
  
  8
- Strange, I get a mild hostility vibe from colleagues if I review too ambitiously.
  
  6
Like the other guy, I also read your comment twice looking for mistakes but found none.
You should of left something to fix!
😏

Edit: I'm glad there so many people who are as passionate about the correct spelling of "should've" as I am. I was testing you all, and you passed!

11
- Correcting the reviewer.
  Notes: "should of" isn't valid, should implies a verb, of isn't a verb. I expect you meant "should have". Please recall this in future submissions.
  
  14
Notably, a good code review should also bring up the good parts of the submission, and not just concentrate on the errors. Not only does it make the recipient feel better to get positive feedback among the negative, but it helps them learn about good practices too. Just concentrating on the errors doesn't really tell them which things they're doing well.

Many reviewers concentrate on just finding mistakes, and while it's useful it's sort of the bare minimum; a good code review should be educational. Especially if the submitter's a more junior coder, in which case it'd also be a good idea to not just outright tell them how you'd fix some problem, but sort of lead them to a solution by asking them questions and pointing things out and letting them do the thinking themselves. But still, experienced coders will also benefit from well-structured feedback, it's not like we're "finished" and stopped learning.

7
- Yes, I tend to do that, and thankfully some of my colleagues do too. Clever but readable solutions, following good and relevant practices, clear documentation, making a good MR description that makes it easier to review, and more.
  
  2
I'm juggling 3 languages

We Americans like to forget that anyone might have any trouble understanding English especially in cases of polyglots.

I don't know which is your native tongue but from this comment it looks like you're doing a fine job.

5
Yeah, I learn so much from code reviews and they've saved me so much time from dumb mistakes I missed. I've also caught no shortage of bugs in other people's code that saved us all a stressful headache. It's just vastly easier to fix a bug before it merges than once it breaks a bunch of people.

5
Assuming you have competent leadership, then it wouldn't be merged if you missed something obvious. I guess you're saying that you want more positive reinforcement.

2

I will correct both + your spelling because it drives me fucking nuts when I can't find a function or variable due to it being severely misspelled

56

Me omw to tell the POSiX guys it's supposed to be "O_CREATE" instead of "O_CREAT":

19
- Chars are expensiv
  
  32

Correcting my code is helpful. The machine didn't know what I even meant. Computers are interesting and changing rapidly.

Correcting my grammar is an unsolicited English lesson from someone who already knew what I meant. English is not interesting or changing quickly.

41

English changes very quickly. New words come out every year. Some programming languages takes years for updates.

11
- Also that person may have known what you meant, but another might not and may have any number of reasons for not asking.
  
  Better communication skills are a worthwhile goal and there's no good reason to not learn and grow.
  
  7
- Except for front-end technologies like JavaScript where there's a new framework every week lol
  
  2
- Which is easier - read a 50-year-old letter, or run a 50-year-old program?
  
  1
- Yeah, but what percentage of normal speech is made up by words under 20 years old?
  
  1
What if your grammar is that bad that people struggle to understand you?

I know someone who is incomprehensible most of the time. I have to ask probing questions just to vaguely understand what they're trying to communicate. I've politely told them more than once about the issue but they never try; they're not mentally challenged or anything, just an ass.

11
- I've never met a native speaker like that, but yeah I think they're the exception that proves the rule.
  
  1
- Then they couldn't correct you.
  
  1
fr fr no cap

1

I think I’ve seen every combination of these. I am personally the approving Keanu for both.

25

I read your comment twice, looking for any tiny mistake to fix. How thoughtless of you not to include any.

21
- I thought I've included one. 👀
  
  3

It's actually "their'yre" dumby, learn ur words

16

It’s actually “their’yre” dumby, learn ur words

SOme morans should of staid inn School!!

18
- get a brane morans
  
  3

You're* grammer

11

Grammar is code.

9

However, real grammar and prescribed textbook grammar are two different things.

5
- Anybody who bitches about prescriptivism is just mad that their grammar sucks.
  
  Edit: this always gets 'em crawling out of the woodwork
  
  -1

Fuck me, never touch my code, it is perfect.

3

Brother you don't even remember what it does, how and why after 3 days

10
- Of course, but because it is perfect, no one, not even myself, needs to fix/modify/extend/understand
  
  /s
  
  3

Someone Renames your objects "because they sound better that way"...

3

I use incorrect grammar all the time on Lemmy because I'm writing colloquially, comma splices are my biggest offense.

2

Excuse me, I think you meant "correct's you're code"

1

It should be normalized to kiss the furry femboy programmer who corrects your code as a thank you.

1

0