From a8f45ba4b1109316e6fe55bca45694c1aa7acbc6 Mon Sep 17 00:00:00 2001 From: Qianqian Fang Date: Mon, 22 Jan 2024 18:21:38 -0500 Subject: [PATCH] add spell checking action --- .github/workflows/spellcheck.yml | 22 +++++++++++++ .wordlist.txt | 55 ++++++++++++++++++++++++++++++++ Binary_JData_Specification.md | 4 +-- 3 files changed, 79 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/spellcheck.yml create mode 100644 .wordlist.txt diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..aec5ff5 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,22 @@ +name: spellcheck +on: + push: + branches: + - master + tags: + - '*' + pull_request: + branches: + - master + +jobs: + check-spelling: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Check Spelling + uses: rojopolis/spellcheck-github-actions@0.23.0 + with: + config_path: .spellcheck.yml + task_name: Markdown diff --git a/.wordlist.txt b/.wordlist.txt new file mode 100644 index 0000000..d8a9a71 --- /dev/null +++ b/.wordlist.txt @@ -0,0 +1,55 @@ +Acknowledgement +andy +backends +bjd +bjdata +BJData +bool +BSON +CBOR +ce +delim +ECMA +Endian +Endianness +fe +findable +github +googlegroups +imagedata +International +interoperable +Javascript +jdata +JData +json +JSON +Kalla +len +MarkDown +md +MessagePack +NaN +Ndim +neurojson +NeuroJSON +noop +num +nx +Nx +Ny +Nz +OpenJData +passcode +pre +Qianqian +Riyad +rolecode +SHTFTN +sizeof +UBJSON +UBJSON's +uint +UiuImLMLhdDC +UTF +whitespaces diff --git a/Binary_JData_Specification.md b/Binary_JData_Specification.md index b8df510..054fc52 100644 --- a/Binary_JData_Specification.md +++ b/Binary_JData_Specification.md @@ -263,7 +263,7 @@ integers are written in Big-Endian order). #### Float All float types (`half`, `single`, `double` are written in **Little-Endian order** -(this is different from UBJSON which does not specify the endianness of floats). +(this is different from UBJSON which does not specify the Endianness of floats). - `float16` or half-precision values are written in [IEEE 754 half precision floating point format](https://en.wikipedia.org/wiki/IEEE_754-2008_revision), which has the following @@ -462,7 +462,7 @@ are qualified. All zero-length types (`T,F,Z,N`), variable-length types(`S, H`) and container types (`[,{`) shall not be used in an optimized _type_ header. This restriction is set to reduce the security risks due to potentials of buffer-overflow attacks using [zero-length markers](https://github.com/nlohmann/json/issues/2793), -hampered readability and dimished benefit using variable/container +hampered readability and diminished benefit using variable/container types in an optimized format. The requirements for _type_ are