This repository has been archived by the owner on Aug 5, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Started writing the task TODO descriptions so that make more sense to… #48
Open
kdorff
wants to merge
13
commits into
Kotlin:master
Choose a base branch
from
kdorff:revised-text
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… me. Will provide a sample for a PR to see if the original author concurs.
Hi Kevin! Great thing to do, thank you :). Yes, let's improve the task descriptions to make them easier to understand. I'll be able to review the changes in a week (after my vacation), so you can continue and add more changes. |
… Developing an general structure to follow.
… me. Will provide a sample for a PR to see if the original author concurs.
… Developing an general structure to follow.
@@ -1,5 +1,10 @@ | |||
package iii_conventions | |||
|
|||
/** | |||
* Pre-defined classes for tasks in iii_conventions | |||
* DO NOT CHANGE THIS FILE. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't get why you'd tell not to modify this file as you have to implement several things in it (compareTo() etc...). Do you have something else in mind ?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Let me provide some background. I recently found the Kotlin Koans. I am familiar with the Koans idea and have been wanting to try it for SOME language. I am interested in learning Kotlin, so hey, no time like the present.
I started going through these and felt that the TODO descriptions were often a bit terse for me. I would often stare at the description and not feel like I really had any idea what I was supposed to do for a problem.
I decided that the issue is I needed a little more guidance, especially in the early tasks. I've updated some TODO text to hopefully provide a bit more guidance.
Before I do rewrite more of these TODO's I wanted to see if you agree this is useful. You may be working on this already or you may be 100% happy with what already exists (both of these scenarios are completely fine with me).