Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Aug 24, 2024

Conversation

rkabhishek
Copy link
Contributor

@rkabhishek rkabhishek commented Jun 22, 2024

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
Copy link
Contributor Author

rkabhishek commented Jun 22, 2024

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
Copy link
Contributor

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.

@manumafe98 manumafe98 added the x:size/medium Medium amount of work label Jul 12, 2024
@rkabhishek rkabhishek force-pushed the fix-grammar-error-handling-exercise branch from aed7372 to 0a48807 Compare August 23, 2024 11:55
@rkabhishek rkabhishek force-pushed the fix-grammar-error-handling-exercise branch from 0a48807 to a347d74 Compare August 23, 2024 11:59
@rkabhishek rkabhishek changed the title Fix grammar errors in the error-handling exercise instructions Fix error-handling exercise instructions Aug 23, 2024
@rkabhishek rkabhishek force-pushed the fix-grammar-error-handling-exercise branch from 9a5dc59 to 7dbc26d Compare August 23, 2024 12:13
@rkabhishek rkabhishek changed the title Fix error-handling exercise instructions Fix the definition of unchecked exception in the error-handling exercise instructions Aug 23, 2024
@kahgoh
Copy link
Member

kahgoh commented Aug 24, 2024

Changes looks good to me. Thanks!

@kahgoh kahgoh merged commit 85e331f into exercism:main Aug 24, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
x:size/medium Medium amount of work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants