From 3280e0f0192006014ff54315a87bf6afe190f9fb Mon Sep 17 00:00:00 2001
From: Kim K <koomen@protonmail.com>
Date: Thu, 20 Jun 2019 11:54:41 +0200
Subject: [PATCH] feat: Add README.md in the playground/ directory rather then
 inline comments

---
 playground/README.md   | 7 +++++++
 playground/test.coffee | 3 ---
 playground/test.java   | 5 -----
 playground/test.js     | 5 -----
 playground/test.kt     | 5 -----
 playground/test.lua    | 3 ---
 playground/test.php    | 5 -----
 playground/test.py     | 5 -----
 playground/test.rb     | 3 ---
 playground/test.scala  | 5 -----
 10 files changed, 7 insertions(+), 39 deletions(-)
 create mode 100644 playground/README.md

diff --git a/playground/README.md b/playground/README.md
new file mode 100644
index 00000000..7f16e6c5
--- /dev/null
+++ b/playground/README.md
@@ -0,0 +1,7 @@
+# Playground
+
+The playground directory contains test scenarios for every filetype and/or
+language that is being supported by DoGe. This so that testing can be done
+quickly.
+
+It is expected to add a playground file when implementing a new language.
diff --git a/playground/test.coffee b/playground/test.coffee
index 17cb4214..f1a3fa2c 100644
--- a/playground/test.coffee
+++ b/playground/test.coffee
@@ -1,6 +1,3 @@
-# This file contains test scenarios and their expected results. You should be
-# able to generate the examples below.
-
 ###
 @description TODO
 @function myFunc
diff --git a/playground/test.java b/playground/test.java
index dd544a5d..056c4331 100644
--- a/playground/test.java
+++ b/playground/test.java
@@ -1,8 +1,3 @@
-/**
- * This file contains test scenarios and their expected results. You should be
- * able to generate the examples below.
- */
-
 class Test {
   /**
    * TODO
diff --git a/playground/test.js b/playground/test.js
index cbffcb7c..03c66b71 100644
--- a/playground/test.js
+++ b/playground/test.js
@@ -1,8 +1,3 @@
-/**
- * This file contains test scenarios and their expected results. You should be
- * able to generate the examples below.
- */
-
 // =============================================================================
 //
 // Vanilla
diff --git a/playground/test.kt b/playground/test.kt
index 92f30f72..76aacf61 100644
--- a/playground/test.kt
+++ b/playground/test.kt
@@ -1,8 +1,3 @@
-/**
- * This file contains test scenarios and their expected results. You should be
- * able to generate the examples below.
- */
-
  // Variable types
  // - var
  // - val (read-only)
diff --git a/playground/test.lua b/playground/test.lua
index 4a213be7..ee029ea3 100644
--- a/playground/test.lua
+++ b/playground/test.lua
@@ -1,8 +1,5 @@
 -- #! /usr/bin/env lua
 
--- This file contains test scenarios and their expected results. You should be
--- able to generate the examples below.
-
 -- TODO
 -- @param arg1 TODO
 -- @param arg2 TODO
diff --git a/playground/test.php b/playground/test.php
index e2b68806..1089f6b9 100644
--- a/playground/test.php
+++ b/playground/test.php
@@ -1,10 +1,5 @@
 <?php
 
-/**
- * This file contains test scenarios and their expected results. You should be
- * able to generate the examples below.
- */
-
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route as BaseRoute;
 use Symfony\Component\HttpFoundation\RedirectResponse as RedirectResponseBase, Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
diff --git a/playground/test.py b/playground/test.py
index 788448ba..544ebdaa 100644
--- a/playground/test.py
+++ b/playground/test.py
@@ -2,11 +2,6 @@
 # -*- coding: utf-8 -*-
 # vim: fenc=utf-8 ts=4 sw=4 et
 
-"""
-This file contains test scenarios and their expected results. You should be able
-to generate the examples below.
-"""
-
 def myFunc():
     """
     TODO
diff --git a/playground/test.rb b/playground/test.rb
index 09fbe0b4..e74d3eea 100644
--- a/playground/test.rb
+++ b/playground/test.rb
@@ -1,8 +1,5 @@
 #!/usr/bin/env ruby
 
-# This file contains test scenarios and their expected results. You should be
-# able to generate the examples below.
-
 # TODO
 # @param arg1 [type] TODO
 # @param arg_2 [type] TODO
diff --git a/playground/test.scala b/playground/test.scala
index c2a85643..9ddad863 100644
--- a/playground/test.scala
+++ b/playground/test.scala
@@ -2,11 +2,6 @@
 // Functions
 // =============================================================================
 
-/**
- * This file contains test scenarios and their expected results. You should be
- * able to generate the examples below.
- */
-
 /** TODO
  *
  * @param x Int TODO