Lint (#30)

.gaplint.yml

@@ -0,0 +1,2 @@
+disable:
+ - align-assignments

.github/workflows/CI.yml

@@ -4,14 +4,14 @@ name: CI
 on:
  push:
  branches:
- - master
+ - main
  pull_request:
 
 # the `concurrency` settings ensure that not too many CI jobs run in parallel
 concurrency:
  # group by workflow and ref; the last slightly strange component ensures that for pull
  # requests, we limit to 1 concurrent job, but for the master branch we don't
- group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref != 'refs/heads/master' || github.run_number }}
+ group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref != 'refs/heads/main' || github.run_number }}
  # Cancel intermediate builds, but only if it is a pull request build.
  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 
@@ -28,7 +28,6 @@ jobs:
  - stable-4.12
  - stable-4.11
  - stable-4.10
- - stable-4.9
 
  steps:
  - uses: actions/checkout@v4

CHANGELOG

@@ -1,7 +1,7 @@
 #############################################################################
 ##
 #W CHANGELOG Smallsemi - a GAP library of semigroups
-#Y Copyright (C) 2008-2019 Andreas Distler & James D. Mitchell
+#Y Copyright (C) 2008-2024 Andreas Distler & James D. Mitchell
 ##
 ## Licensing information can be found in the README file of this package.
 ##
@@ -55,16 +55,16 @@
 ===============
 
  - a minor release fixing some bugs in the references in the documentation,
- and moving some declarations of properties and associated true methods to 
- the GAP library to avoid clashes with the forthcoming Semigroups package. 
+ and moving some declarations of properties and associated true methods to
+ the GAP library to avoid clashes with the forthcoming Semigroups package.
  - Smallsemi now requires GAP 4.7
 
 ===============
  Version 0.6.6 (24/04/13)
 ===============
 
  - added starred Green's relations
- - fixed the swap of L- and R-classes 
+ - fixed the swap of L- and R-classes
  - fixed bug in D-class computation when MinimalGeneratingSet is known
 
 ===============
@@ -78,26 +78,26 @@
  Version 0.6.4 (10/10/11)
 ===============
 
- - made Smallsemi compatible with Citrus 0.2. 
+ - made Smallsemi compatible with Citrus 0.2.
 
 ===============
  Version 0.6.3 (13/09/11)
 ===============
 
- - made Smallsemi compatible with GAP 4.5 and Citrus 0.1. 
+ - made Smallsemi compatible with GAP 4.5 and Citrus 0.1.
 
  - introduced SmallsemiMakeDoc, SmallsemiTestAll, SmallsemiTestManualExamples.
 
 ===============
  Version 0.6.2 (06/07/10)
 ===============
 
- - included an example in the manual which explains a workaround for a 
+ - included an example in the manual which explains a workaround for a
  current performance issue of enumerators of semigroups of order 8
  suggested by Michal Stolorz.
 
- - minor changes relating to the compatibility of Smallsemi with the 
- MONOID package and with some library functions. 
+ - minor changes relating to the compatibility of Smallsemi with the
+ MONOID package and with some library functions.
 
 ===============
  Version 0.6.0 (12/02/10)

PackageInfo.g

@@ -1,18 +1,18 @@
 #############################################################################
 ##
-#W PackageInfo.g Smallsemi - a GAP library of semigroups
-#Y Copyright (C) 2008-2015 Andreas Distler & James D. Mitchell
+## PackageInfo.g Smallsemi - a GAP library of semigroups
+## Copyright (C) 2008-2024 Andreas Distler & James D. Mitchell
 ##
 ## Licensing information can be found in the README file of this package.
 ##
 #############################################################################
 ##
 
-SetPackageInfo( rec(
+SetPackageInfo(rec(
 PackageName := "Smallsemi",
 Subtitle := "A library of small semigroups",
 Version := "0.6.13",
-Date := "28/02/2022", # this is in dd/mm/yyyy format
+Date := "28/02/2022",  # this is in dd/mm/yyyy format
 License := "GPL-3.0-or-later",
 
 Persons := [
@@ -21,34 +21,34 @@ Persons := [
  IsAuthor := true,
  IsMaintainer := false,
  Email := "a.distler@tu-bs.de",
- ),
+),
  rec(
  LastName := "Mitchell",
  FirstNames := "James",
  IsAuthor := true,
  IsMaintainer := true,
  Email := "jdm3@st-and.ac.uk",
  WWWHome := "http://tinyurl.com/jdmitchell",
- PostalAddress := Concatenation( [
+ PostalAddress := Concatenation([
  "Mathematical Institute\n", "North Haugh\n",
- "St Andrews\n", "Fife\n", "KY16 9SS\n", "Scotland"] ),
+ "St Andrews\n", "Fife\n", "KY16 9SS\n", "Scotland"]),
  Place := "St Andrews",
  Institution := "University of St Andrews"
- )
+)
 ],
 Status := "deposited",
 
 PackageWWWHome := "https://gap-packages.github.io/smallsemi/",
-README_URL := Concatenation( ~.PackageWWWHome, "README" ),
-PackageInfoURL := Concatenation( ~.PackageWWWHome, "PackageInfo.g" ),
+README_URL := Concatenation(~.PackageWWWHome, "README"),
+PackageInfoURL := Concatenation(~.PackageWWWHome, "PackageInfo.g"),
 SourceRepository := rec(
  Type := "git",
  URL := "https://github.com/gap-packages/smallsemi",
 ),
-IssueTrackerURL := Concatenation( ~.SourceRepository.URL, "/issues" ),
-ArchiveURL := Concatenation( ~.SourceRepository.URL,
+IssueTrackerURL := Concatenation(~.SourceRepository.URL, " / issues"),
+ArchiveURL := Concatenation(~.SourceRepository.URL,
  "/releases/download/v", ~.Version,
- "/smallsemi-", ~.Version ),
+ " / smallsemi -", ~.Version),
 ArchiveFormats := ".tar.gz",
 
 AbstractHTML :=
@@ -66,32 +66,31 @@ PackageDoc := rec(
 ),
 
 Dependencies := rec(
- GAP := ">=4.8",
+ GAP := ">=4.10",
  NeededOtherPackages := [],
  SuggestedOtherPackages := [],
  ExternalConditions :=
  ["gzip is needed in standard location if data files are used uncompressed"]),
 AvailabilityTest := ReturnTrue,
 BannerString := Concatenation(
- ListWithIdenticalEntries(SizeScreen()[1]-3, '-'), "\n", ~.PackageName,
+ ListWithIdenticalEntries(SizeScreen()[1] - 3, '-'), "\n", ~.PackageName,
  " - ", ~.Subtitle, "\n",
  "by ", ~.Persons[1].FirstNames, " ", ~.Persons[1].LastName,
- " & " , ~.Persons[2].FirstNames, " ", ~.Persons[2].LastName, "\n",
- "For contents, type: ?Smallsemi:\n" ,
+ " & ", ~.Persons[2].FirstNames, " ", ~.Persons[2].LastName, "\n",
+ "For contents, type: ?Smallsemi:\n",
  "Loading ", ~.PackageName, " ", ~.Version, " ...\n",
- ListWithIdenticalEntries(SizeScreen()[1]-3, '-'), "\n" ),
+ ListWithIdenticalEntries(SizeScreen()[1] - 3, '-'), "\n"),
 TestFile := "tst/testall.g",
 Keywords := ["small semigroups", "data library", "multiplication tables"],
 
 AutoDoc := rec(
  entities := rec(
  VERSION := ~.Version,
- ARCHIVENAME := Remove( SplitString( ~.ArchiveURL, "/" ) ),
- ),
+ ARCHIVENAME := Remove(SplitString(~.ArchiveURL, " / "))),
  TitlePage := rec(
- Version := Concatenation( "Version ", ~.Version ),
+ Version := Concatenation("Version ", ~.Version),
  Copyright := """
- &copyright; 2008-19 A. Distler &amp; J. D. Mitchell.<P/>
+ &copyright; 2008-24 A. Distler &amp; J. D. Mitchell.<P/>
 
  <Package>Smallsemi</Package> is free software: you can
  redistribute it and/or modify it under the terms of the GNU
@@ -116,7 +115,8 @@ AutoDoc := rec(
  Colophon := """
  If you find any bugs or have any suggestions or comments, we would
  very much appreciate it if you would let us know via our
- issue tracker (see <URL>https://github.com/gap-packages/smallsemi/issues</URL>).
+ issue tracker (see
+ <URL>https://github.com/gap-packages/smallsemi/issues</URL>).
  """,
 
  Acknowledgements := """
@@ -127,8 +127,6 @@ AutoDoc := rec(
  The first author acknowledges financial support of the University
  of St Andrews. The second author acknowledges support of EPSRC
  grant number GR/S/56085/01.
- """,
- ),
+ """),
 ),
 ));
-

README

@@ -1,6 +1,6 @@
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 + +
-+ Copyright (C) 2008-2015 Andreas Distler & James D. Mitchell +
++ Copyright (C) 2008-2024 Andreas Distler & James D. Mitchell +
 + +
 + 'Smallsemi' is free software: you can redistribute it and/or modify +
 + it under the terms of the GNU General Public License as published by +
@@ -20,7 +20,7 @@
 + +
 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
- This is the 
+ This is the
  README
  ======
  file for the
@@ -67,7 +67,7 @@ least 1 GB of RAM available. With less than 512 MB not all the semigroups of
 size 8 can be accessed.
 
 ***disk space***
-As the data in the library is compressed, 30 MB of disk space will be 
+As the data in the library is compressed, 30 MB of disk space will be
 sufficient to install 'Smallsemi' under Unix. To use the library under
 Windows the data has to be uncompressed and will then occupy approx. 1.6 GB.
 
@@ -85,7 +85,7 @@ steps; see Section 74.1 in the reference manual of GAP for further details:
 2) Move the archive inside a 'pkg' directory. This can be either the main
  'pkg' directory in your GAP installation or your personal 'pkg' directory.
 
-3) Complete the installation by unpacking the archive, e.g. under Linux type 
+3) Complete the installation by unpacking the archive, e.g. under Linux type
 
  tar -xzf smallsemi-0.6.13.tar.gz
 
@@ -98,7 +98,7 @@ steps; see Section 74.1 in the reference manual of GAP for further details:
 
 After installation the folder 'smallsemi-0.6.13' should contain the directories
 
- data, doc, gap, and tst 
+ data, doc, gap, and tst
 
 and the files