learn-co-curriculum / phase-3-reading-error-messages Goto Github PK

Canvas Link

https://learning.flatironschool.com/courses/5286/assignments/172778?module_item_id=376608

Concern

It would be easier to just flat out mention that the following section is meant to be ran in a related Ruby script:
This is the related section I am referring to:

For instance:

2.times do
  puts "hi"

Additional Context

No response

Suggested Changes

This should be changed for better clarification:

For instance, if we create a Ruby script that contains the following code snippet:

2.times do
  puts "hi"

If we later run this same Ruby script above, this will result in this error:

2: syntax error, unexpected end-of-input, expecting keyword_end

Canvas Link

https://learning.flatironschool.com/courses/5187/assignments/180455?module_item_id=397714

Concern

in this text:
Error messages have 3 parts:

lib/a_name_error.rb:3:in <main>': undefined local variable or method hello_world' for main:Object (NameError)

1. The location of the error, the "where":
   .
   .
   .

2. The description, the "why":
   .
   .

3. The type of error, the "who":

Additional Context

No response

Suggested Changes

change formatter so that this:

1. The description, the "why":
   .
   .

2. The type of error, the "who":

appears as:
2. The description, the "why":
.
.

3. The type of error, the "who":

Hardcode these? Use bullets? It seems that the numbering starts fresh with "1." for each issue

Canvas Link

https://learning.flatironschool.com/courses/5187/assignments/180455?module_item_id=397714

Concern

For what it's worth, I don't see this error message
TypeError: String can't be coerced into Fixnum

but instead see:
TypeError: String can't be coerced into Integer

Additional Context

No response

Suggested Changes

Maybe other people see "Fixnum" so the message still matches for them.

For me when I see "Integer" on the screen, I think "Flatiron's stuff isn't keeping up."

? Maybe change to:
TypeError: String can't be coerced into Integer

Canvas Link

https://learning.flatironschool.com/courses/5187/assignments/180455?module_item_id=397714

Concern

Readers can comprehend the meaning of this, but the extra mental processing isn't worth it:
Errors are clues, and reading them is the interpreter telling you what to do to fix the program and move on.

Additional Context

No response

Suggested Changes

Maybe change this:
Errors are clues, and reading them is the interpreter telling you what to do to fix the program and move on.

to this?:
Error messages are clues. Reading them lets the interpreter guide you in fixing the program and moving on.