feat: Add README.md in the playground/ directory rather then inline c…

…omments
kkoomen · Jun 20, 2019 · 3280e0f · 3280e0f
1 parent 793ef26
commit 3280e0f
Show file tree

Hide file tree

Showing 10 changed files with 7 additions and 39 deletions.
diff --git a/playground/README.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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