diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml new file mode 100644 index 0000000..4e192f2 --- /dev/null +++ b/.github/workflows/style.yml @@ -0,0 +1,25 @@ +name: Style + +on: + push: + branches: ["main"] + pull_request: + branches: ["main"] + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + spellcheck: + name: Spelling + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + ref: ${{ github.event.pull_request.head.sha }} + show-progress: false + - uses: codespell-project/actions-codespell@master + with: + exclude_file: site/java/testapidocs/script-dir/jquery-3.5.1.min.js,site/java/apidocs/script-dir/jquery-3.5.1.min.js diff --git a/java/src/main/java/io/github/moctave/weftspace/DataNode.java b/java/src/main/java/io/github/moctave/weftspace/DataNode.java index 1375fea..8829230 100644 --- a/java/src/main/java/io/github/moctave/weftspace/DataNode.java +++ b/java/src/main/java/io/github/moctave/weftspace/DataNode.java @@ -99,7 +99,7 @@ public DataNode() { * Multiple distinct nodes may have the same hash code, as * (1) the mechanics for name.hashCode() and flag.hashCode() are not controlled, * (2) parents are not taken into account in this method, and - * (3) nodes which have themself as a child will not have their childen considered. + * (3) nodes which have themself as a child will not have their children considered. * @return A hash code value for this node. */ @Override diff --git a/java/src/main/java/io/github/moctave/weftspace/Logger.java b/java/src/main/java/io/github/moctave/weftspace/Logger.java index 07e692c..5b58e3d 100644 --- a/java/src/main/java/io/github/moctave/weftspace/Logger.java +++ b/java/src/main/java/io/github/moctave/weftspace/Logger.java @@ -194,7 +194,7 @@ public void printPrefix(PrintStream stream) { /** - * Ends the message, reseting formating. If this message is a fatal error, calling + * Ends the message, resetting formatting. If this message is a fatal error, calling * this method will also exit the program with an error code of 1. */ public void endMessage(PrintStream stream) { diff --git a/python/weftspace/data_node.py b/python/weftspace/data_node.py index 58b3153..1942050 100644 --- a/python/weftspace/data_node.py +++ b/python/weftspace/data_node.py @@ -141,7 +141,7 @@ def __hash__(self): Multiple distinct nodes may have the same hash code, as (1) the mechanics for hash() are not controlled, (2) parents are not taken into account in this method, and - (3) nodes which have themself as a child will not have their childen considered. + (3) nodes which have themself as a child will not have their children considered. """ prime: int = 31 hash_code: int = 1 diff --git a/python/weftspace/logger.py b/python/weftspace/logger.py index 978b1a9..685d567 100644 --- a/python/weftspace/logger.py +++ b/python/weftspace/logger.py @@ -163,7 +163,7 @@ def print_prefix(self, stream: TextIO): def end_message(self, stream: TextIO): """ - Ends the message, reseting formating. If this message is a fatal error, calling + Ends the message, resetting formatting. If this message is a fatal error, calling this method will also exit the program with an error code of 1. """ stream.write(Logger.RESET) diff --git a/site/java/apidocs/index-all.html b/site/java/apidocs/index-all.html index dcb2d10..ebbac65 100644 --- a/site/java/apidocs/index-all.html +++ b/site/java/apidocs/index-all.html @@ -205,7 +205,7 @@

E

endMessage(PrintStream) - Method in class io.github.moctave.weftspace.Logger.Message
-
Ends the message, reseting formating.
+
Ends the message, resetting formatting.
equals(Object) - Method in class io.github.moctave.weftspace.DataNode
diff --git a/site/java/apidocs/io/github/moctave/weftspace/DataNode.html b/site/java/apidocs/io/github/moctave/weftspace/DataNode.html index 197dc62..8618ca9 100644 --- a/site/java/apidocs/io/github/moctave/weftspace/DataNode.html +++ b/site/java/apidocs/io/github/moctave/weftspace/DataNode.html @@ -310,7 +310,7 @@

hashCode

Multiple distinct nodes may have the same hash code, as (1) the mechanics for name.hashCode() and flag.hashCode() are not controlled, (2) parents are not taken into account in this method, and - (3) nodes which have themself as a child will not have their childen considered. + (3) nodes which have themself as a child will not have their children considered.
Overrides:
hashCode in class Object
diff --git a/site/java/apidocs/io/github/moctave/weftspace/Logger.Message.html b/site/java/apidocs/io/github/moctave/weftspace/Logger.Message.html index bdcc010..b593da4 100644 --- a/site/java/apidocs/io/github/moctave/weftspace/Logger.Message.html +++ b/site/java/apidocs/io/github/moctave/weftspace/Logger.Message.html @@ -124,7 +124,7 @@

Method Summary

void
endMessage(PrintStream stream)
-
Ends the message, reseting formating.
+
Ends the message, resetting formatting.
void
formatOn(PrintStream stream)
@@ -212,7 +212,7 @@

printPrefix

endMessage

public void endMessage(PrintStream stream)
-
Ends the message, reseting formating. If this message is a fatal error, calling +
Ends the message, resetting formatting. If this message is a fatal error, calling this method will also exit the program with an error code of 1.
diff --git a/site/java/project-info.html b/site/java/project-info.html index c859f94..db2f181 100644 --- a/site/java/project-info.html +++ b/site/java/project-info.html @@ -79,7 +79,7 @@

Overview

This document lists the dependencies that are defined through dependencyManagement. Distribution Management -This document provides informations on the distribution management of this project. +This document provides information on the distribution management of this project. About Weftspace is a Java library designed to provide the maximum possible level of support for Endless Sky datafile syntax. As well as providing read/write functionality through the DataReader and DataWriter classes, it provides support for handling the data nodes themselves. diff --git a/site/python/weftspace/data_node.html b/site/python/weftspace/data_node.html index 47f7671..87ec9c4 100644 --- a/site/python/weftspace/data_node.html +++ b/site/python/weftspace/data_node.html @@ -182,7 +182,7 @@

Classes

Multiple distinct nodes may have the same hash code, as (1) the mechanics for hash() are not controlled, (2) parents are not taken into account in this method, and - (3) nodes which have themself as a child will not have their childen considered. + (3) nodes which have themself as a child will not have their children considered. """ prime: int = 31 hash_code: int = 1 diff --git a/site/python/weftspace/logger.html b/site/python/weftspace/logger.html index ced9b6f..235441b 100644 --- a/site/python/weftspace/logger.html +++ b/site/python/weftspace/logger.html @@ -196,7 +196,7 @@

Classes

def end_message(self, stream: TextIO): """ - Ends the message, reseting formating. If this message is a fatal error, calling + Ends the message, resetting formatting. If this message is a fatal error, calling this method will also exit the program with an error code of 1. """ stream.write(Logger.RESET)