Add docs for run command

djsegal · Mar 18, 2017 · 8cb10b5 · 8cb10b5
1 parent b772ae9
commit 8cb10b5
Show file tree

Hide file tree

Showing 6 changed files with 95 additions and 2 deletions.
diff --git a/docs/app/router.js b/docs/app/router.js
@@ -15,6 +15,7 @@ Router.map(function() {
     this.route('init');
     this.route('new');
     this.route('test');
+    this.route('run');
   });
 });
 

diff --git a/docs/app/routes/commands/run.js b/docs/app/routes/commands/run.js
@@ -0,0 +1,4 @@
+import Ember from 'ember';
+
+export default Ember.Route.extend({
+});
diff --git a/docs/app/templates/application.hbs b/docs/app/templates/application.hbs
@@ -32,6 +32,7 @@
             {{#submenu-item active=(is-active "commands.init" currentRouteName) onClick=(transition-to "commands.init")}}Init{{/submenu-item}}
             {{#submenu-item active=(is-active "commands.generate" currentRouteName) onClick=(transition-to "commands.generate")}}Generate{{/submenu-item}}
             {{#submenu-item active=(is-active "commands.destroy" currentRouteName) onClick=(transition-to "commands.destroy")}}Destroy{{/submenu-item}}
+            {{#submenu-item active=(is-active "commands.run" currentRouteName) onClick=(transition-to "commands.run")}}Run{{/submenu-item}}
             {{#submenu-item active=(is-active "commands.test" currentRouteName) onClick=(transition-to "commands.test")}}Test{{/submenu-item}}
           {{/liquid-if}}
         </div>

diff --git a/docs/app/templates/commands/run.hbs b/docs/app/templates/commands/run.hbs
@@ -0,0 +1,67 @@
+{{#docs-body bodyTitle="The Run Command"}}
+
+  <h3>
+    Command:
+  </h3>
+
+
+  {{#code-block language='julia'}}
+
+Julz.run()
+  {{/code-block}}
+
+  <br>
+
+  <h3>
+    Description:
+  </h3>
+
+  <p>
+
+    Run the main function.
+
+  </p>
+
+  <br>
+
+  {{paper-divider}}
+
+  <br>
+
+  <h3>
+    Parameter(s):
+  </h3>
+
+  {{#paper-data-table as |table|}}
+
+    {{#table.head as |head|}}
+      {{#head.column}}Name{{/head.column}}
+      {{#head.column}}Value{{/head.column}}
+    {{/table.head}}
+
+    {{#table.body as |body|}}
+
+      {{#body.row as |row|}}
+        {{#row.cell}} none {{/row.cell}}
+        {{#row.cell}} - {{/row.cell}}
+      {{/body.row}}
+
+    {{/table.body}}
+
+  {{/paper-data-table}}
+
+  <br>
+
+  <h3>
+    Source:
+  </h3>
+
+  <ul>
+    <li>
+      <a target="_blank" href="https://github.com/djsegal/Julz.jl/blob/master/src/functions/run.jl">
+        src/functions/run.jl
+      </a>
+    </li>
+  </ul>
+
+{{/docs-body}}
diff --git a/docs/app/templates/getting-started.hbs b/docs/app/templates/getting-started.hbs
@@ -88,7 +88,16 @@ end
   <br>
 
   <p>
-    You can now run every {{link-to 'test' 'commands.test' }} using:
+    You can now {{link-to 'run' 'commands.run' }} your code using:
+  </p>
+
+  {{#code-block language='julia'}}
+
+Julz.run()
+  {{/code-block}}
+
+  <p>
+    And {{link-to 'test' 'commands.test' }} everything using:
   </p>
 
   {{#code-block language='julia'}}
@@ -97,7 +106,7 @@ Julz.test()
   {{/code-block}}
 
   <p>
-    And when you get bored of the <code>foo</code> type, you can {{link-to 'destroy' 'commands.destroy' }} it with:
+    Then when you get bored of the <code>foo</code> type, you can {{link-to 'destroy' 'commands.destroy' }} it with:
   </p>
 
   {{#code-block language='julia'}}

diff --git a/docs/tests/unit/routes/commands/run-test.js b/docs/tests/unit/routes/commands/run-test.js
@@ -0,0 +1,11 @@
+import { moduleFor, test } from 'ember-qunit';
+
+moduleFor('route:commands/run', 'Unit | Route | commands/run', {
+  // Specify the other units that are required for this test.
+  // needs: ['controller:foo']
+});
+
+test('it exists', function(assert) {
+  let route = this.subject();
+  assert.ok(route);
+});