Skip to content
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions dic/acronyms.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ POSIX:
QoS: Quality of Service

REANNZ: Research Education Advanced Network New Zealand
RDC: Research Developer Cloud
SCP:
long: Means of securely transferring files between over an SSH connection.
short: Secure Copy Protocol
Expand Down Expand Up @@ -128,6 +129,7 @@ VNC: Virtual Network Computing
VPN:
long: Method of extending access to a private network.
short: Virtual Private Network
VRAM: Virtual RAM
WCRP: World Climate Research Programme
WSL: Windows Subsystem for Linux
XVFB:
Expand Down
4 changes: 3 additions & 1 deletion dic/commands.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
Nano:
checkcase: false
srun:
srun:
sbatch:
env:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This file is missing a final newline character. It's a good practice to end files with a single newline for POSIX compatibility and to prevent issues with some command-line tools.

1 change: 1 addition & 0 deletions dic/inexplicably-absent.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
admonition:
analytics:
annum:
backfill:
collapsable:
customisable:
customisations:
Expand Down
4 changes: 4 additions & 0 deletions dic/jargon_cs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ filesystem:
glob: &ref_0
short: A pattern that specifies sets of filenames with wildcard characters, used by the Unix Bash shell.
globbing: *ref_0
hostname:
plural: true
hyperthreaded:
hyperthreading:
inode:
Expand All @@ -53,6 +55,8 @@ namespace:
nav:
nobackup:
parallelisation:
pragma:
plural: true
precompiled: Sofware that is already compiled before you get hold of it.
preprocessor: A program that processes its input data to produce output that is used as input in another program.
profiler:
Expand Down
1 change: 1 addition & 0 deletions dic/misc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ onboarding:
rollout:
Ancil: Short for Ancilliary
md:
venv: Virtual environment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other dictionary files and for better maintainability, it's good practice to keep entries sorted alphabetically. This file is currently not sorted. Consider sorting all entries alphabetically.

3 changes: 3 additions & 0 deletions dic/proper_names.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ AgResearch:
Allinea:
Amdahl:
Aotearoa:
possessive: true
Apache:
Broadwell:
Bruijn:
Expand Down Expand Up @@ -34,8 +35,10 @@ OpenSSL: A software library for applications that provide secure communications
Otago:
Pletzer:
Schrödinger:
possessive: true
Skylake:
Slurm:
possessive: true
Tuakiri: New Zealand federated identity and access management.
WEKA: Parallel Filesystem
Xeon:
Expand Down
76 changes: 45 additions & 31 deletions dic/software_names.yaml
Original file line number Diff line number Diff line change
@@ -1,47 +1,55 @@
---
WRF: Weather Research Forecasting Model
Fortran:
MobaXterm:
AOCL: AOCL is a set of numerical libraries optimized for AMD processors
Aspera:
AutoDock:
Bioconductor:
CentOS:
CESM:
CIME:
conda:
Conda:
RStudio:
cron: A job scheduler on Unix-like operating systems
crontab:
Cylc:
cylc:
DCV:
Dask:
Nanopore:
Miniconda:
CESM:
WinSCP:
MKL:
Nsight:
OpenACC:
MacOS:
PuTTY:
OpenGL:
OnDemand: Open OnDemand
GeneMark:
DCV:
FASTA: Bioinformatics file format.
FreeIPA:
AOCL: AOCL is a set of numerical libraries optimized for AMD processors
Xming:
FENSAP:
FASTQ:
Bioconductor:
FENSAP:
Fortran:
FreeIPA:
GeneMark:
GridRunner:
GTK: open-source toolkit for creating graphical user interfaces

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There appears to be a typo in ImagMagick. The correct spelling is ImageMagick.

ImageMagick:

LAPACK:
Kraken:
CentOS:
cron: A job scheduler on Unix-like operating systems
crontab:
Illumina:
ImagMagick:
IOBUF:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The entry Julia+Pluto.ji has a couple of issues:

  1. It violates the project's schema for dictionary keys (/^[^\w\-]+$/), as + is not an allowed character. This is a critical issue that will likely break the build.
  2. The .ji extension appears to be a typo for .jl, the correct extension for Julia files and Pluto notebooks.

There is also a separate Pluto.ji entry on line 47 which seems redundant and also has the .jl typo.

Consider replacing these with valid and correct entries, for example, separate entries for Julia and Pluto.jl.

Keycloak:
Kibana: Kibana is a source-available data visualization dashboard software for Elasticsearch.
Jinja:
ImagMagick:
Illumina:
conda:
Julia+Pluto.ji:
Jupyter: A web-based interactive computing platform
JupyterHub: Is a multi-user Hub that spawns, manages, and proxies multiple instances of the single-user Jupyter notebook server.
Keras:
Keycloak:
Kibana: Kibana is a source-available data visualization dashboard software for Elasticsearch.
Kraken:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The software is usually referred to as Lmod. For consistency, it would be better to use the correct capitalization, especially since checkcase is on by default for most entries. An entry for Lmod already exists in dic/proper_names.yaml.

Lmod:

LAPACK:
lmod:
MacOS:
Miniconda:
MKL:
MobaXterm:
Nanopore:
Nsight:
OnDemand: Open OnDemand
OpenACC:
OpenGL:
PacBio:
Pluto.ji:
pthread:
PuTTY:
RStudio:
AutoDock:
GridRunner:
gfortran: GNU Fortran compiler.
Expand All @@ -54,5 +62,11 @@ NumPy:
Matplotlib:
SciPy:
rsync: rsync is a utility for transferring and synchronizing files between a computer and a storage drive and across networked computers
Synda:
schedmd:
VSCode: Visual Studio Code
WinSCP:
WRF: Weather Research Forecasting Model
Xming:
Xorg: Free and open-source implementation of the X Window System.
Xquartz: Open-source effort to develop a version of the X.Org X Window System that runs on macOS.
42 changes: 31 additions & 11 deletions dic/te_reo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,41 @@
# Maori
# While 'mi_NZ' dictionaries exist, not all spellcheckers can handle multiple.
# Easier to just impliment through a word list.
Māui:
possessive: True
hapū: kinship group
iwi: tribe
kaitiaki: Guardian
kaitiakitanga: Guardianship
kia:
Kirikiriroa:
Kuhukuhu: to enter/go in/join # Uni of Waikato IT hub
Mahuika:
possessive: True
Manaaki:
Māui:
possessive: True
mihi:
ngā:
nga: #Annoyingly pyspell doesn't acnowledge macrons? Hopefully this is temporary.
mihi:
kia:
ora:
Manaaki:
Whenua:
Ōtautahi:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This line has a trailing space. Several other new lines also have trailing spaces (e.g., 23, 25, 27, 34, 36, 38). These should be removed to keep the file clean and consistent.

Ōtautahi:

possessive: True

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The boolean value True is used here and on lines 24, 26, 28, 30, 32, 35, 37, and 39. However, other YAML files in this project use lowercase true. While YAML parsers handle both, it's best to be consistent across the project. Please use true.

  possessive: true

Otautahi:
possessive: True
Ōtepoti:
possessive: True
Otepoti:
possessive: True
Tāmaki:
possessive: True
Tamaki:
kaitiaki: Guardian
kaitiakitanga: Guardianship
iwi: tribe
hapū: kinship group
whānau: family
possessive: True
taonga: precious or treasured
Tauranga:
possessive: True
Te Whanganui-a-Tara:
possessive: True
Waikato:
possessive: True
whānau: family
whanau: #Annoyingly pyspell doesn't acnowledge macrons? Hopefully this is temporary.
Whenua:
Loading