search

exercism / java

Exercism exercises in Java.
https://exercism.org/tracks/java
MIT License
689 stars 671 forks source link

Fix the definition of unchecked exception in the error-handling exercise instructions #2814

Closed rkabhishek closed 1 month ago

rkabhishek commented 3 months ago

pull request

This PR clarifies the definition of unchecked exception and fixes minor grammar errors in the error-handling exercise instructions.

Reviewer Resources:

Track Policies

rkabhishek commented 3 months ago

Hi, I have 2 questions regarding the documentation for this exercise:

  1. I think that the line I have edited is not true, right? Out of memory comes under the category of Error which denotes a serious problem. In contrast, unchecked exceptions are the ones that usually are programming bugs that can be fixed and are a subclass of RuntimeException. Please let me know if I am wrong. If not, the docs can be clarified.

  2. The file I edited is called instructions.append.md . I also see an instructions.md file. Can we keep the content in one file only?

manumafe98 commented 2 months ago

Hey @rkabhishek

  1. I think that the line I have edited is not true, right? Out of memory comes under the category of Error which denotes a serious problem. In contrast, unchecked exceptions are the ones that usually are programming bugs that can be fixed and are a subclass of RuntimeException. Please let me know if I am wrong. If not, the docs can be clarified.

Yes, you're right that part of the doc is not clear in its current state, if you have an idea on how to make it clearer go ahead!

  1. The file I edited is called instructions.append.md . I also see an instructions.md file. Can we keep the content in one file only?

Normally the append file is for extra notes and we do not mind to have 2 files, I can see that in this one the majority of the instructions are on the append that is weird.

kahgoh commented 1 month ago

Changes looks good to me. Thanks!