summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJovansonlee Cesar <ivanceras@gmail.com>2023-08-10 23:47:41 +0800
committerGitHub <noreply@github.com>2023-08-10 23:47:41 +0800
commit3585a88213c5168a3e7943e02d9248858c95d628 (patch)
treecfe3e07e9007b66ec0e076be62ec3640e8c6421b
parent608db0bbc4589952fce86cea1bf5844d9943102f (diff)
parent228e3511d535150404dd215b3f3d48b80b2db857 (diff)
Merge pull request #99 from deining/bump-workflow-actions
Bump workflow actions
-rw-r--r--.github/workflows/release.yml10
-rw-r--r--.github/workflows/rust.yml2
-rw-r--r--Architecture.md4
-rw-r--r--TODO.md2
-rw-r--r--deny.toml4
-rw-r--r--packages/svgbob/spec.md2
-rw-r--r--packages/svgbob/src/buffer/cell_buffer/cell.rs2
-rw-r--r--packages/svgbob/src/buffer/cell_buffer/endorse.rs2
-rw-r--r--packages/svgbob/src/buffer/cell_buffer/span.rs2
-rw-r--r--packages/svgbob/src/buffer/fragment_buffer/fragment/arc.rs4
-rw-r--r--packages/svgbob/src/buffer/fragment_buffer/fragment/circle.rs2
-rw-r--r--packages/svgbob/src/buffer/fragment_buffer/fragment/line.rs2
-rw-r--r--packages/svgbob/src/buffer/property_buffer.rs2
-rw-r--r--packages/svgbob/src/buffer/property_buffer/property.rs4
-rw-r--r--packages/svgbob/test_data/long.bob24
15 files changed, 34 insertions, 34 deletions
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index ddf8e86..087cf62 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -25,17 +25,17 @@ jobs:
# suffix: ""
steps:
- - uses: actions/checkout@master
+ - uses: actions/checkout@v3
- - uses: actions/cache@v1
+ - uses: actions/cache@v3
with:
path: ~/.cargo/registry
key: '${{ runner.os }}-cargo-registry-${{ hashFiles(''**/Cargo.lock'') }}'
- - uses: actions/cache@v1
+ - uses: actions/cache@v3
with:
path: ~/.cargo/git
key: '${{ runner.os }}-cargo-index-${{ hashFiles(''**/Cargo.lock'') }}'
- - uses: actions/cache@v1
+ - uses: actions/cache@v3
with:
path: target
key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}
@@ -54,7 +54,7 @@ jobs:
args: --release
- name: Archive Binaries
- uses: actions/upload-artifact@v2
+ uses: actions/upload-artifact@v3
with:
name: ${{ matrix.target }}
path: ./target/release/svgbob${{ matrix.suffix}}
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
index d5eb81d..de16872 100644
--- a/.github/workflows/rust.yml
+++ b/.github/workflows/rust.yml
@@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- name: Install nightly
run: rustup toolchain install nightly && rustup override set nightly
diff --git a/Architecture.md b/Architecture.md
index 9b8fe03..b126f7d 100644
--- a/Architecture.md
+++ b/Architecture.md
@@ -427,7 +427,7 @@ PropertyBuffer is calculated only once for each character, so the succeeding loo
**How the fragments are conceived based on a character?**
-**Neighbor character:** There are 8 neighbors of a character and each character on the input is checked agains this 8 neighbor for appropriate drawing element
+**Neighbor character:** There are 8 neighbors of a character and each character on the input is checked against this 8 neighbor for appropriate drawing element
```bob
+---------+ +------+ +--------+
@@ -621,7 +621,7 @@ These fragments are processed such as merging collinear lines that are touching
...
- /// This function is calling on endorse algorithmn on fragments that
+ /// This function is calling on endorse algorithm on fragments that
/// are neighbors, but not necessarily touching to be promoted to a shape.
/// These includes: circle, arc, and line with arrow heads.
fn endorse_circles_and_arcs(groups: Vec<Contacts>) -> (Vec<Fragment>, Vec<Contacts>) {
diff --git a/TODO.md b/TODO.md
index 8a75749..ee13205 100644
--- a/TODO.md
+++ b/TODO.md
@@ -31,7 +31,7 @@
- nalgebra
- ncollide2d -> parry2d
- [X] Make the top-level directory a workspace and put svgbob and cli into packages/
-- [X] Make a trait for the merging algorithmns
+- [X] Make a trait for the merging algorithms
- [X] merge_recursive
- [X] first_pass_merge
- [X] second_pass_merge
diff --git a/deny.toml b/deny.toml
index f5b62e0..2b5f171 100644
--- a/deny.toml
+++ b/deny.toml
@@ -66,7 +66,7 @@ ignore = [
[licenses]
# The lint level for crates which do not have a detectable license
unlicensed = "deny"
-# List of explictly allowed licenses
+# List of explicitly allowed licenses
# See https://spdx.org/licenses/ for list of possible licenses
# [possible values: any SPDX 3.7 short identifier (+ optional exception)].
allow = [
@@ -76,7 +76,7 @@ allow = [
"BSD-2-Clause",
"ISC",
]
-# List of explictly disallowed licenses
+# List of explicitly disallowed licenses
# See https://spdx.org/licenses/ for list of possible licenses
# [possible values: any SPDX 3.7 short identifier (+ optional exception)].
deny = [
diff --git a/packages/svgbob/spec.md b/packages/svgbob/spec.md
index b1f5c5c..50a0fb0 100644
--- a/packages/svgbob/spec.md
+++ b/packages/svgbob/spec.md
@@ -6,7 +6,7 @@ Svgbob is a diagramming model which uses common typing characters to approximate
|characters| names | description
|----------|----------------------|------------
-| `-` | dash, hypen, minus | for horizontal lines
+| `-` | dash, hyphen, minus | for horizontal lines
| `_` | underscore | for horizontal lines
| `\|` | pipe, or | for vertical lines
| `/` | forward slash | for lines slanted to the right
diff --git a/packages/svgbob/src/buffer/cell_buffer/cell.rs b/packages/svgbob/src/buffer/cell_buffer/cell.rs
index 237edf8..286b6cb 100644
--- a/packages/svgbob/src/buffer/cell_buffer/cell.rs
+++ b/packages/svgbob/src/buffer/cell_buffer/cell.rs
@@ -57,7 +57,7 @@ impl Ord for Cell {
macro_rules! cell_grid {
($($a:ident),*) => {
- /// The point at sepcific cell grid of this cell
+ /// The point at specific cell grid of this cell
$(pub fn $a(&self) -> Point {
self.top_left_most() + CellGrid::$a()
})*
diff --git a/packages/svgbob/src/buffer/cell_buffer/endorse.rs b/packages/svgbob/src/buffer/cell_buffer/endorse.rs
index 5f1808a..6f4e514 100644
--- a/packages/svgbob/src/buffer/cell_buffer/endorse.rs
+++ b/packages/svgbob/src/buffer/cell_buffer/endorse.rs
@@ -67,7 +67,7 @@ fn is_rect(fragments: &[&Fragment]) -> bool {
/// qualifications:
/// - 8 fragments
-/// - 2 parallell pair
+/// - 2 parallel pair
/// - 4 aabb right angle arc (top_left, top_right, bottom_left, bottom_right)
/// - each of the right angle touches 2 lines that are aabb_perpendicular
pub fn endorse_rounded_rect(fragments: &[&Fragment]) -> Option<Rect> {
diff --git a/packages/svgbob/src/buffer/cell_buffer/span.rs b/packages/svgbob/src/buffer/cell_buffer/span.rs
index 39a8299..b388542 100644
--- a/packages/svgbob/src/buffer/cell_buffer/span.rs
+++ b/packages/svgbob/src/buffer/cell_buffer/span.rs
@@ -57,7 +57,7 @@ impl Span {
}
/// if any cell of this span is adjacent to any cell of the other
- /// Use .rev() to check the last cell of this Span agains the first cell of the other Span
+ /// Use .rev() to check the last cell of this Span against the first cell of the other Span
/// They have a high change of matching faster
pub(super) fn can_merge(&self, other: &Self) -> bool {
self.iter().rev().any(|(cell, _)| {
diff --git a/packages/svgbob/src/buffer/fragment_buffer/fragment/arc.rs b/packages/svgbob/src/buffer/fragment_buffer/fragment/arc.rs
index 152e1a9..d879a19 100644
--- a/packages/svgbob/src/buffer/fragment_buffer/fragment/arc.rs
+++ b/packages/svgbob/src/buffer/fragment_buffer/fragment/arc.rs
@@ -7,7 +7,7 @@ use sauron::{
};
use std::{cmp::Ordering, fmt};
-/// TODO: Add an is_broken field when there is a presense of `~` or `!` in the span
+/// TODO: Add an is_broken field when there is a presence of `~` or `!` in the span
#[derive(Debug, Clone)]
pub struct Arc {
pub start: Point,
@@ -139,7 +139,7 @@ impl Arc {
}
/// check to see if the arc is aabb right angle
- /// that is the center x and y coordinate is alinged to both of the end points
+ /// that is the center x and y coordinate is aligned to both of the end points
/// This will be used for checking if group of fragments can be a rounded rect
pub fn is_aabb_right_angle_arc(&self) -> bool {
let center = self.center();
diff --git a/packages/svgbob/src/buffer/fragment_buffer/fragment/circle.rs b/packages/svgbob/src/buffer/fragment_buffer/fragment/circle.rs
index f8c64ca..429b728 100644
--- a/packages/svgbob/src/buffer/fragment_buffer/fragment/circle.rs
+++ b/packages/svgbob/src/buffer/fragment_buffer/fragment/circle.rs
@@ -13,7 +13,7 @@ use sauron::{
Node,
};
-/// TODO: Add an is_broken field when there is a presense of `~` or `!` in the span
+/// TODO: Add an is_broken field when there is a presence of `~` or `!` in the span
#[derive(Debug, Clone)]
pub struct Circle {
pub radius: f32,
diff --git a/packages/svgbob/src/buffer/fragment_buffer/fragment/line.rs b/packages/svgbob/src/buffer/fragment_buffer/fragment/line.rs
index aa1aa87..1b656f0 100644
--- a/packages/svgbob/src/buffer/fragment_buffer/fragment/line.rs
+++ b/packages/svgbob/src/buffer/fragment_buffer/fragment/line.rs
@@ -366,7 +366,7 @@ impl Line {
Line::new_noswap(self.start, Point::new(cx, cy), self.is_broken)
}
- /// extend but on the oposite direction
+ /// extend but on the opposite direction
/// TODO: This implementation is hacky
pub fn extend_start(&self, length: f32) -> Self {
let mut tmp_line = self.clone();
diff --git a/packages/svgbob/src/buffer/property_buffer.rs b/packages/svgbob/src/buffer/property_buffer.rs
index c55c8bb..a91a475 100644
--- a/packages/svgbob/src/buffer/property_buffer.rs
+++ b/packages/svgbob/src/buffer/property_buffer.rs
@@ -12,7 +12,7 @@ mod property;
/// which contains the property of each cell
/// This will be used in the first phase of converting ascii diagrams into fragment buffer
/// The properties are generated once and will be repeatedly used for the second phase
-/// where testing the neighboring charaters to determine the fragment to be drawn for that cell.
+/// where testing the neighboring characters to determine the fragment to be drawn for that cell.
#[derive(Default, Clone)]
pub struct PropertyBuffer<'p>(HashMap<Cell, &'p Property>);
diff --git a/packages/svgbob/src/buffer/property_buffer/property.rs b/packages/svgbob/src/buffer/property_buffer/property.rs
index de2678d..5fe2684 100644
--- a/packages/svgbob/src/buffer/property_buffer/property.rs
+++ b/packages/svgbob/src/buffer/property_buffer/property.rs
@@ -59,7 +59,7 @@ pub struct Property {
signature: Vec<(Signal, Vec<Fragment>)>,
/// behavior is the final output of fragments of the spot character
- /// depending on flag that is meet when checked agains the surrounding characters
+ /// depending on flag that is meet when checked against the surrounding characters
pub behavior: Arc<
dyn Fn(
&Property,
@@ -123,7 +123,7 @@ impl Property {
}
}
- /// empty property serves as a substitue for None property for simplicity in
+ /// empty property serves as a substitute for None property for simplicity in
/// the behavior code, never have to deal with Option
pub fn empty() -> Self {
Property {
diff --git a/packages/svgbob/test_data/long.bob b/packages/svgbob/test_data/long.bob
index 5c4660d..3c4fed1 100644
--- a/packages/svgbob/test_data/long.bob
+++ b/packages/svgbob/test_data/long.bob
@@ -620,15 +620,15 @@ test测试--> 测试test
. .
|\ /\ /|
- _____| \_____/ \________/ |__________
- ,' -> create Ascii art `.
- / -> draw sketches for e-mails \
-| -> comment source code of programs |
-| -> diagrams for visually handicaped people (
-| -> more dialogs >
-| (
- \ -> ... /
- `._______ ____ ____ ___ __________,'
+ _____| \_____/ \________/ |___________
+ ,' -> create Ascii art `.
+ / -> draw sketches for e-mails \
+| -> comment source code of programs |
+| -> diagrams for visually handicapped people (
+| -> more dialogs >
+| (
+ \ -> ... /
+ `._______ ____ ____ ___ ___________,'
/,' | / \ | `.\
/' |/ \| `\
. .
@@ -864,7 +864,7 @@ What can it do?
V /| \ '-----> Reception
Team / . \
v /| \
- Worklaod / . '-->> Career change
+ Workload / . '-->> Career change
V /
PTO /
V
@@ -1036,7 +1036,7 @@ Board `-------------------
_______ _
_.-'|+__|__-|'-._,.-(((_)
-There,a battery powering a tessla coil.
+There, a battery powering a tesla coil.
+10-15V ___0,047R
@@ -1512,7 +1512,7 @@ IN>----||------+-------| 2N2222 O<--||---> High impedance output
|
|
---
- \ / LED (glows when 555 ouput is high)
+ \ / LED (glows when 555 output is high)
V
---
|