Chore - Intro code examples by hhandoko · Pull Request #8 · SingaporeScalaProgrammers/scala-workshop

hhandoko · 2017-09-08T02:13:22Z

As mentioned in the group discussion, I've split the exercise code from the example / reference code and updated the README.md accordingly.

The exercise code now resides under exercises/ and the example / reference under references/. I've made links to the code snippets to the relevant source files to make it easier to navigate. There are also minor fixes to the example code, where a parameter argument is not being used (but I assume is needed).

In regards to README.md, mainly:

split long paragraph into point form (where possible) to make it more readable,
split the first part of 'Decomplecting Function' to ease-in the introduction 😁

shishkin

Thanks for the improvements @hhandoko. I have a couple of MD syntax related issues and the .gitignore that I would like to be improved as well.

shishkin · 2017-09-10T14:45:54Z

.gitignore

@@ -1,2 +1,266 @@
-*.class
-*.log
+# Created by https://www.gitignore.io/api/osx,vim,code,linux,emacs,windows,eclipse,intellij+all


I know nobody really looks into .gitignore but I generally dislike generated bloat like this. As a developer I want to understand what files are being created in the project directory and why. If those are my custom tools, I would ignore them at ~/.gitignore level.

Perhaps I'll add some comments with a bit of explanation.

My goal here was to ignore all system / OS-specific files (like OSX's .DStore) and editor / IDE config files which gets generated automatically and often accidentally committed.

I'm covering three main OS (Win, OSX, *nix) and common editors.

When the .gitignore starts mentioning files that you didn't even know existed, there is a risk of accidentally not committing a file. And the pursuit of ignoring all system files is pointless because you never know what strange tools and temp files people are going to have. That's why Git has a user-specific ~/.gitignore file.

That makes sense... I'll revert.

shishkin · 2017-09-10T14:49:16Z

exercises/intro/README.md

+<center>
+  <small>
+    _(source: [Loop1.java](https://github.com/SingaporeScalaProgrammers/scala-workshop/blob/master/references/intro/src/main/java/Loop1.java))_
+  </small>


What is this syntax doing? In the preview https://github.com/SingaporeScalaProgrammers/scala-workshop/blob/a5773757e08d4a1de72ce544d59927766104ca9e/exercises/intro/README.md it's not looking nice. Not sure how is it intended be rendered.

Complete fail 😁 I'll figure out alternative format (and keep it readable in raw MD).

shishkin · 2017-09-10T14:50:08Z

exercises/intro/README.md

+program while learning core FP concepts such as:
+
+* referential transparency,
+* expression-based programming,


Thanks! Breaking down long sentences in bullet points is good 👍

shishkin · 2017-09-10T14:52:10Z

exercises/intro/README.md

 this case;
-3. `1 to 10` defines a inclusive `Range` – a sequence that can be enumerated;
-4. `for (x <- seq) { ...x... }` enumerates elements of `seq` executing the 
+1. `1 to 10` defines a inclusive `Range` – a sequence that can be enumerated;


I know that MD renderer will turn this into a numbered list, but I prefer the text itself to be readable too (that was the selling point of MD, IIRC). A numbered list with ones somewhat defeats that purpose.

Good point, will revert.

shishkin · 2017-09-10T14:55:41Z

intro/src/main/java/Loop1.java

@@ -0,0 +1,12 @@
+public class Loop1 {
+    public static void main(String[] args) {
+        int sum = 0;


Good idea to put all the steps there. For a small tutorial like this it's good to have all the steps constantly present and it's not too many of them.

shishkin · 2017-09-10T14:57:33Z

intro/README.md


 def sumOfEvenSquares(max: Int): Int = {
-  (1 to 10)
+  (1 to max)


Nice catch 👍

shishkin · 2017-09-10T15:02:20Z

exercises/intro/README.md

+```scala
+def iterate(max: Int): List[Int] = ???
+def filterEven(xs: List[Int]): List[Int] = ???
+def square(xs: List[Int]): List[Int] = ???


Good trick 👍 I didn't think about using ??? to show the intermediary step here.

shishkin · 2017-09-10T15:05:56Z

exercises/intro/README.md


-By a lucky coincidence Scala standard library collection API already provides
-most of the functions that we've just discovered. It would be a shame not to 
-use them:


This supposed to be a joke 🤣

Wooosh 😅 I'll add air quotes, haha.

… one

hhandoko · 2017-09-13T01:53:37Z

@shishkin I've made the changes as we discussed. I've also uploaded the diff preview files.

Note that the diff links on the MD file points to the master branch (which will 404 until this PR is merged). Have a look here for a preview: https://rawgit.com/SingaporeScalaProgrammers/scala-workshop/chore/intro_code_examples/references/intro/diff/Loop3-Loop4.html

shishkin · 2017-09-14T15:12:53Z

references/intro/diff/Loop3-Loop4.html

@@ -0,0 +1,260 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">


Now I see what did you mean with the diff.

hhandoko added 5 commits August 31, 2017 12:21

Add Loop runnable code as reference

c254c98

Add links to source code for reference

a960e27

Fix code example to utilise max parameter

4220c83

Split code into exercises and references

fbfb76f

Break long paragraph in intro to make it easier to read

a577375

hhandoko requested review from damien-neveu, shishkin and slawekrogulski September 8, 2017 02:13

shishkin requested changes Sep 10, 2017

View reviewed changes

hhandoko added 7 commits September 13, 2017 09:06

Replace ordered list with regular numbering instead of MD auto-parsed…

375b0cf

… one

Replace unordered list symbol to - for consistency

8017189

Fix MD rendering for source code links

37e0f47

Simplify and replace link into footnote-style

b0d1290

Revert and add air quotes ;)

9803b09

Add generated diff output

f70c2f7

Scrub filesystem path

9e8a620

hhandoko added 2 commits September 13, 2017 09:53

Add links to diff preview

e776285

Fix link to Loop1.java file

74e41e2

shishkin reviewed Sep 14, 2017

View reviewed changes

		@@ -0,0 +1,260 @@
		<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

Conversation

hhandoko commented Sep 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shishkin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hhandoko commented Sep 13, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hhandoko commented Sep 8, 2017 •

edited

Loading