Revert changes

paddyroddy · paddyroddy · commit 2076cd7491e3 · 2025-06-05T21:41:05.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -9,7 +9,7 @@ body:
     attributes:
       label: Is Your Feature Request Related to a Problem? Please Describe
       description: A clear and concise description of what the problem is.
-      placeholder: I'm always frustrated when […]
+      placeholder: I'm always frustrated when [...]
     validations:
       required: true
   - id: solution
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2023-2025 UCL Centre for Advanced Research Computing
+Copyright (c) 2023-2025 UCL Centre for Advanced Research Computing
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
diff --git a/README.md b/README.md
@@ -15,15 +15,11 @@ repo, and we welcome questions there or in the `#helpme` channel on the
 🍪 Our template is a [cookiecutter] template which automatically creates new
 Python packages with our recommended tooling set up and ready to go.
 
-<!-- vale proselint.Annotations = NO -->
-
 > [!NOTE]
 > If you're making a package within a community that has an existing
 > package template (e.g., [`scikit-hep`](https://github.com/scikit-hep/cookie)),
 > we recommend using their template instead of this one.
 
-<!-- vale proselint.Annotations = YES -->
-
 ## Tutorial
 
 Some quick instructions for using our template are below.
diff --git a/docs/LICENSE b/docs/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright © 2022-2025 just-the-docs
+Copyright (c) 2022-2025 just-the-docs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/docs/pages/ci.md b/docs/pages/ci.md
@@ -27,7 +27,7 @@ during tests.
 | Name                                     | Short description                                                                                                                                                                                                                                                                      |                     🚦                      |
 | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------------------------------------: |
 | [Codecov](https://docs.codecov.com/docs) | Hosted service to report code coverage metrics. Occasionally slow to update after a report is updated, can be configured to add extra CI checks. This service is probably more widely used and is [free for both open-source and private projects](https://about.codecov.io/pricing/). | <span class="label label-green">Best</span> |
-| [Coveralls](https://docs.coveralls.io/)  | Hosted service to report code coverage metrics. Similar to codecov and we don't strongly recommend one over the other. This service is only [free for open-source projects](https://coveralls.io/pricing).                                                                             | <span class="label label-green">Best</span> |
+| [Coveralls](https://docs.coveralls.io/)  | Hosted service to report code coverage metrics. Very similar to codecov and we don't strongly recommend one over the other. This service is only [free for open-source projects](https://coveralls.io/pricing).                                                                        | <span class="label label-green">Best</span> |
 
 <details><summary>  <span class="label label-green">Best</span>  explanation</summary> <!-- markdownlint-disable-line MD033 -->
 Both services are similar, so both <span class="label label-green">Best</span>.
diff --git a/docs/pages/docs.md b/docs/pages/docs.md
@@ -5,7 +5,7 @@ layout: default
 
 ## Documentation
 
-With Python, as with many other languages, it's common to automatically
+With Python, as with many other languages, it's very common to automatically
 create a web page with documentation. This can include reference for the API
 taken from your package's [docstrings], tutorials, examples, and more in depth
 explanation about how the package works. For an in-depth discussion of the
@@ -28,7 +28,7 @@ If you're using GitHub, one option is to host your docs on [GitHub pages].
 | Name      | Short description                                                                                                                                               |                      🚦                      |
 | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------: |
 | [MkDocs]  | Generates documentation from Markdown files, with a plugin to generate API documentation. A good plugin ecosystem and balance of usability and customisability. | <span class="label label-green">Best</span>  |
-| [Sphinx]  | Generates documentation from reStructuredText or Markdown files, long been the de-facto standard and widely used. Mature plugin ecosystem.                      | <span class="label label-yellow">Good</span> |
+| [Sphinx]  | Generates documentation from reStructuredText or Markdown files, long been the de-facto standard and very widely used. Mature plugin ecosystem.                 | <span class="label label-yellow">Good</span> |
 | [gitbook] | General documentation builder; integrates with GitHub.                                                                                                          | <span class="label label-yellow">Good</span> |
 | [pdoc]    | Auto-generates API documentation from docstrings, beginner friendly but with less of a plugin ecosystem than others.                                            | <span class="label label-yellow">Good</span> |
 
diff --git a/docs/pages/libraries/parallel-async.md b/docs/pages/libraries/parallel-async.md
@@ -26,7 +26,7 @@ simply due to pre-existing code using a library like [pandas].
 | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------: |
 | [multiprocess]       | A fork of [multiprocessing] which uses `dill` instead of `pickle` to allow serializing wider range of object types including nested / anonymous functions. We've found this easier to use than `multiprocessing`. | <span class="label label-green">Best</span>  |
 | [concurrent.futures] | [See the table below](#asynchronous-processing).                                                                                                                                                                  | <span class="label label-yellow">Good</span> |
-| [dask]               | Aims to make scaling existing code in familiar libraries (`numpy`, [pandas], `scikit-learn`, …) easy.                                                                                                             | <span class="label label-yellow">Good</span> |
+| [dask]               | Aims to make scaling existing code in familiar libraries (`numpy`, [pandas], `scikit-learn`, ...) easy.                                                                                                           | <span class="label label-yellow">Good</span> |
 | [multiprocessing]    | The standard library module for distributing tasks across multiple processes.                                                                                                                                     | <span class="label label-yellow">Good</span> |
 | [mpi4py]             | Support for MPI based parallelism.                                                                                                                                                                                | <span class="label label-yellow">Good</span> |
 | [threading]          | The standard library module for multi-threading. Due to the _global interpreter lock_ [currently][PEP703] only one thread can execute Python code at a time.                                                      |  <span class="label label-red">Avoid</span>  |
diff --git a/docs/pages/virtual.md b/docs/pages/virtual.md
@@ -13,7 +13,7 @@ layout: default
 | [pixi]                  | A fast drop-in replacement for `conda`.                                                                                                                                                                                                                                                                       | <span class="label label-yellow">Good</span> |
 | [pyenv]                 | Lets you easily switch between multiple versions of Python.                                                                                                                                                                                                                                                   | <span class="label label-yellow">Good</span> |
 | [virtualenv]            | Creates isolated Python environments, and offers more features than venv.                                                                                                                                                                                                                                     | <span class="label label-yellow">Good</span> |
-| [venv]                  | Creates isolated Python environments. Fewer features than other tools, but widely used and comes built into Python.                                                                                                                                                                                           | <span class="label label-yellow">Good</span> |
+| [venv]                  | Creates isolated Python environments. Fewer features than other tools, but very widely used and comes built into Python.                                                                                                                                                                                      | <span class="label label-yellow">Good</span> |
 | [anaconda]              | Due to recent [licensing ambiguity][anaconda-problems], we recommend avoiding anaconda and many of the default channels. We recommend installing miniforge and sticking to the `conda-forge` channel.                                                                                                         |  <span class="label label-red">Avoid</span>  |
 
 <!-- links here for a more readable table -->
diff --git a/tests/data/test_package_generation/.github/ISSUE_TEMPLATE/bug_report.yml b/tests/data/test_package_generation/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -21,7 +21,7 @@ body:
       value: |-
         import cookiecutter_test
 
-        …
+        ...
       render: Python
     validations:
       required: true
diff --git a/tests/data/test_package_generation/.github/ISSUE_TEMPLATE/feature_request.yml b/tests/data/test_package_generation/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -9,7 +9,7 @@ body:
     attributes:
       label: Is Your Feature Request Related to a Problem? Please Describe
       description: A clear and concise description of what the problem is.
-      placeholder: I'm always frustrated when […]
+      placeholder: I'm always frustrated when [...]
     validations:
       required: true
   - id: solution
diff --git a/tests/data/test_package_generation/LICENSE.md b/tests/data/test_package_generation/LICENSE.md
@@ -1,6 +1,6 @@
 <!-- markdownlint-disable MD041 --># MIT License
 
-Copyright © 2025 Eva Lu Ator
+Copyright (c) 2025 Eva Lu Ator
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
diff --git a/tutorial.md b/tutorial.md
@@ -7,7 +7,7 @@ In this tutorial we will go through in detail the steps required to set-up a Pyt
 
 ## ⚙️ Setting up dependencies for using template
 
-<details><summary>Click to expand… </summary> <!-- markdownlint-disable-line MD033 -->
+<details><summary>Click to expand... </summary> <!-- markdownlint-disable-line MD033 -->
 
 To use the template you will need to install the following software tools
 
@@ -80,7 +80,7 @@ We will first go through the steps for creating a new package using the `UCL-ARC
 
    You will then be shown a series of prompts at the command line asking for details of the project and package. You can choose to use the default placeholder value (shown in parenthesis `()` in prompt) for any question by hitting `Enter`. If you already have a specific project in mind you want to set up a package for using the template you can use this project's details, otherwise you can just use the placeholder values. You should choose `Y` (yes) to the questions on whether to initialise Git repository and automatically deploy HTML documentation to GitHub Pages to allow you to complete the follow on exercises which rely on these options being enabled. For the prompt asking for the GitHub user or organization name to be owner of repository you should supply your GitHub user name.
 
-3. Once you have completed all the cookiecutter prompts some additional instructions will be printed to screen (which we will come back to in the next sections) and your new package will be generated in a directory named `{project_slug}` in the current working directory (where `{project_slug}` is the value entered for the `'Slugified' project name…`[^slug] prompt, this will be `python-template` if you used the default placeholder values). You can see the directory tree of files generated by running
+3. Once you have completed all the cookiecutter prompts some additional instructions will be printed to screen (which we will come back to in the next sections) and your new package will be generated in a directory named `{project_slug}` in the current working directory (where `{project_slug}` is the value entered for the `'Slugified' project name...`[^slug] prompt, this will be `python-template` if you used the default placeholder values). You can see the directory tree of files generated by running
 
    ```sh
    tree {project_slug}
@@ -129,7 +129,7 @@ GitHub CLI detected, you can create a repo with the following:
 gh repo create {github_owner}/{project_slug} -d "{project_description}" --public -r origin --source {project_slug}
 ```
 
-where `{github_owner}`, `{project_slug}` and `{project_description}` are replaced with the relevant GitHub repository owner (user name), project slug and description that you entered when setting up the package using `cookiecutter`. You should now copy-paste and run the `gh repo create …` command that was printed out in the message - if you no longer have access to the message you can use the example above, being careful to subsitute the placeholders in braces `{}` with the relevant values.
+where `{github_owner}`, `{project_slug}` and `{project_description}` are replaced with the relevant GitHub repository owner (user name), project slug and description that you entered when setting up the package using `cookiecutter`. You should now copy-paste and run the `gh repo create ...` command that was printed out in the message - if you no longer have access to the message you can use the example above, being careful to subsitute the placeholders in braces `{}` with the relevant values.
 
 If you get an error message at this point it may be because you have not installed the GitHub CLI or set up the authorisation for the GitHub CLI as [described in the setup instructions above](#%EF%B8%8F-setting-up-dependencies-for-using-template).
 
@@ -270,7 +270,7 @@ Once you have activated the environment you should make sure the version of the
 python -m pip install --upgrade pip
 ```
 
-Similar to `uv`, once the environment is active, you can install the package in editable mode, along with both its required dependencies and optional sets of dependencies by running
+Similar to `uv`, once the the environment is active, you can install the package in editable mode, along with both its required dependencies and optional sets of dependencies by running
 
 ```sh
 python -m pip install --editable ".[dev,docs,test]"
diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/bug_report.yml b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -21,7 +21,7 @@ body:
       value: |-
         import {{cookiecutter.package_name}}
 
-        …
+        ...
       render: Python
     validations:
       required: true
diff --git a/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/feature_request.yml b/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -9,7 +9,7 @@ body:
     attributes:
       label: Is Your Feature Request Related to a Problem? Please Describe
       description: A clear and concise description of what the problem is.
-      placeholder: I'm always frustrated when […]
+      placeholder: I'm always frustrated when [...]
     validations:
       required: true
   - id: solution
diff --git a/{{cookiecutter.project_slug}}/LICENSE.md b/{{cookiecutter.project_slug}}/LICENSE.md
@@ -4,7 +4,7 @@
 
 # MIT License
 
-Copyright © {% now 'utc', '%Y' %} {{cookiecutter.author_given_names}} {{cookiecutter.author_family_names}}
+Copyright (c) {% now 'utc', '%Y' %} {{cookiecutter.author_given_names}} {{cookiecutter.author_family_names}}
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -25,7 +25,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 {%- elif cookiecutter.license == "BSD-3-Clause" -%}
 
-Copyright © {% now 'utc', '%Y' %}, {{cookiecutter.author_given_names}}
+Copyright (c) {% now 'utc', '%Y' %}, {{cookiecutter.author_given_names}}
 {{cookiecutter.author_family_names}} All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -629,7 +629,7 @@ warranty; and each file should have at least the “copyright” line and a poin
 to where the full notice is found.
 
     <one line to give the program's name and a brief idea of what it does.>
-    Copyright © <year>  <name of author>
+    Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -649,14 +649,14 @@ Also add information on how to contact you by electronic and paper mail.
 If the program does terminal interaction, make it output a short notice like
 this when it starts in an interactive mode:
 
-    <program>  Copyright © <year>  <name of author>
+    <program>  Copyright (C) <year>  <name of author>
     This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type 'show c' for details.
 
 The hypothetical commands `show w` and `show c` should show the appropriate
 parts of the General Public License. Of course, your program's commands might be
-different; for a GUI, you would use an “about box”.
+different; for a GUI interface, you would use an “about box”.
 
 You should also get your employer (if you work as a programmer) or school, if
 any, to sign a “copyright disclaimer” for the program, if necessary. For more
