Skip to content

Commit be2b1dd

Browse files
Update Smaug.toml and README.md
* Run RuboCop Linter and update YARD docs * Fill in smaug metadata * Run RuboCop Linter and update YARD docs * Update README.md * Run RuboCop Linter and update YARD docs * Run RuboCop Linter and update YARD docs Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 1e68aee commit be2b1dd

7 files changed

+15
-15
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ Triangles are defined as a hash of points, with any additional information.
3232
```
3333

3434
# TODO
35-
- Document new circle methods
3635
- Alphabetize methods in `dinrall.rb`
3736
- Create `triangle_intersects_triangle?` method
3837
- Create `rectangle_intersects_triangle?` method
@@ -46,6 +45,7 @@ Triangles are defined as a hash of points, with any additional information.
4645
- Impliment any item from the TODO list.
4746
- Write a sample app that more clearly shows all methods
4847
- Write a tutorial
48+
- Improve Documentation
4949
- Submit improved calculation methods
5050
- Speed improvements to the `triangle_raster` and `circle_raster` methods
5151
- Vector calculations for area over Heron's Formula

Smaug.toml

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[project]
22
# The name of your game's executable. This should only contain a-z, A-Z, 0-9, _ or -.
3-
name = "dinraal"
3+
name = "dinraal-sample"
44
# The game's title. This will show up in the tile bar of your executable.
5-
title = "dinraal"
5+
title = "Dinraal Sample"
66
version = "0.1.0"
7-
authors = ["TODO: My Name <todo@example.com>"]
7+
authors = ["Dee Schaedler - deeschaedler@gmail.com"]
88
icon = "metadata/icon.png"
99
compile_ruby = false
1010

@@ -17,6 +17,6 @@ edition = "standard"
1717
[itch]
1818
# The Project URL you set when you created the game on Itch.io. https://my-username.itch.io/my-game.
1919
# This will also be the name of your build files, so fill it out even if you aren't uploading to Itch.io.
20-
url = "todo-change-me"
20+
url = "dinraal-sample"
2121
# Your username on Itch.io.
22-
username = "todo-change-me"
22+
username = "deeschaedler"

docs/Dinraal.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2416,7 +2416,7 @@ <h3 class="signature " id="triangle_raster-instance_method">
24162416
</div>
24172417

24182418
<div id="footer">
2419-
Generated on Fri Nov 12 18:10:43 2021 by
2419+
Generated on Fri Nov 12 20:02:14 2021 by
24202420
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
24212421
0.9.26 (ruby-3.0.2).
24222422
</div>

docs/_index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h2>Namespace Listing A-Z</h2>
9797
</div>
9898

9999
<div id="footer">
100-
Generated on Fri Nov 12 18:10:43 2021 by
100+
Generated on Fri Nov 12 20:02:13 2021 by
101101
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
102102
0.9.26 (ruby-3.0.2).
103103
</div>

docs/file.README.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,6 @@ <h1 id="label-dinraal">dinraal</h1>
9090

9191
<h1 id="label-TODO">TODO</h1>
9292
<ul><li>
93-
<p>Document new circle methods</p>
94-
</li><li>
9593
<p>Alphabetize methods in <code>dinrall.rb</code></p>
9694
</li><li>
9795
<p>Create <code>triangle_intersects_triangle?</code> method</p>
@@ -117,6 +115,8 @@ <h1 id="label-How+to+contribute">How to contribute</h1>
117115
</li><li>
118116
<p>Write a tutorial</p>
119117
</li><li>
118+
<p>Improve Documentation</p>
119+
</li><li>
120120
<p>Submit improved calculation methods</p>
121121
</li><li>
122122
<p>Speed improvements to the <code>triangle_raster</code> and <code>circle_raster</code> methods</p>
@@ -138,7 +138,7 @@ <h1 id="label-About+Dinraal">About Dinraal</h1>
138138
</div></div>
139139

140140
<div id="footer">
141-
Generated on Fri Nov 12 18:10:43 2021 by
141+
Generated on Fri Nov 12 20:02:13 2021 by
142142
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
143143
0.9.26 (ruby-3.0.2).
144144
</div>

docs/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,6 @@ <h1 id="label-dinraal">dinraal</h1>
9090

9191
<h1 id="label-TODO">TODO</h1>
9292
<ul><li>
93-
<p>Document new circle methods</p>
94-
</li><li>
9593
<p>Alphabetize methods in <code>dinrall.rb</code></p>
9694
</li><li>
9795
<p>Create <code>triangle_intersects_triangle?</code> method</p>
@@ -117,6 +115,8 @@ <h1 id="label-How+to+contribute">How to contribute</h1>
117115
</li><li>
118116
<p>Write a tutorial</p>
119117
</li><li>
118+
<p>Improve Documentation</p>
119+
</li><li>
120120
<p>Submit improved calculation methods</p>
121121
</li><li>
122122
<p>Speed improvements to the <code>triangle_raster</code> and <code>circle_raster</code> methods</p>
@@ -138,7 +138,7 @@ <h1 id="label-About+Dinraal">About Dinraal</h1>
138138
</div></div>
139139

140140
<div id="footer">
141-
Generated on Fri Nov 12 18:10:43 2021 by
141+
Generated on Fri Nov 12 20:02:13 2021 by
142142
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
143143
0.9.26 (ruby-3.0.2).
144144
</div>

docs/top-level-namespace.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h2>Defined Under Namespace</h2>
100100
</div>
101101

102102
<div id="footer">
103-
Generated on Fri Nov 12 18:10:43 2021 by
103+
Generated on Fri Nov 12 20:02:13 2021 by
104104
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
105105
0.9.26 (ruby-3.0.2).
106106
</div>

0 commit comments

Comments
 (0)