ruby icon indicating copy to clipboard operation
ruby copied to clipboard

[V3] Use consistent naming for method references

Open ErikSchierboom opened this issue 5 years ago • 6 comments

Looking at the existing Ruby exercises, there are a couple of different ways methods are referred to. I've seen:

  • 'Please implement the pass? method'
  • 'Please implement the LogLineParser.log_level method'
  • 'Please implement the Lasagna#remaining_minutes_in_oven method'

There are several places where methods are being referred to, but most notably they are referred to in the instructions.md files and the stub implementation files (and occasionally the hints.md files). It would be nice to use a uniform way of referring to methods.

I'm fairly sure that @iHiD wants to use <CLASS>.<METHOD> for class methods, and <CLASS>#<METHOD> for instance methods. So I'd suggest normalizing to those.

ErikSchierboom avatar Jul 21 '20 13:07 ErikSchierboom

I'm fairly sure that @iHiD wants to use <CLASS>.<METHOD> for class methods, and <CLASS>#<METHOD> for instance methods. So I'd suggest normalizing to those.

Correct. Thanks, @ErikSchierboom!

iHiD avatar Jul 21 '20 13:07 iHiD

Hey @ErikSchierboom could I take this issue?

jonathanyeong avatar Oct 02 '20 14:10 jonathanyeong

Yeah sure!

ErikSchierboom avatar Oct 02 '20 17:10 ErikSchierboom

Quick question on the Log Line Parser exercise. The instructions don't seem to reference the class methods which is different to the instructions of the other exercises. E.g.

# current
Implement a method to return a log line's log level, which should be returned in lowercase:

# expected
Implement the `LogLineParser.log_level` method to return a log line's log level, which should be returned in lowercase:

Should I make this change, or just leave it as is?

jonathanyeong avatar Oct 02 '20 23:10 jonathanyeong

Quick question on the Log Line Parser exercise. The instructions don't seem to reference the class methods which is different to the instructions of the other exercises. E.g.

# current
Implement a method to return a log line's log level, which should be returned in lowercase:

# expected
Implement the `LogLineParser.log_level` method to return a log line's log level, which should be returned in lowercase:

Should I make this change, or just leave it as is?

I wonder if this is because the concepts being taught are different, perhaps the difference between class and instance method is assumed to be known at this point?

I have to read the documentation tomorrow of the entire structure and get up to speed with what is here.

kotp avatar Oct 03 '20 04:10 kotp

Should I make this change, or just leave it as is?

Please make this change. This is a mistake in the existing exercise.

ErikSchierboom avatar Oct 06 '20 06:10 ErikSchierboom

This has been normalized. Closing.

kytrinyx avatar Oct 13 '22 17:10 kytrinyx