From 80365975c503c973e7342f7138cfe41b637722d6 Mon Sep 17 00:00:00 2001
From: Ludee <Ludwig.Huelk@rl-institut.de>
Date: Fri, 25 Aug 2023 13:43:46 +0200
Subject: [PATCH] Update and shorten all copyright notices #33

---
 .gitignore                       |  4 ++--
 .pre-commit-config.yaml          |  2 +-
 .reuse/dep5                      | 10 +++++-----
 CHANGELOG.md                     |  2 +-
 CITATION.cff                     | 11 ++++++++---
 CONTRIBUTING.md                  |  2 +-
 RELEASE_PROCEDURE.md             |  2 +-
 USERS.cff                        |  2 +-
 mkdocs.yml                       |  6 +++---
 requirements.txt                 |  4 ++--
 super_repo/__init__.py           |  6 +++---
 super_repo/example_calculator.py |  4 ++--
 super_repo/example_google.py     |  3 ++-
 tests/test_example.py            |  5 +----
 tox.ini                          | 10 +++++-----
 15 files changed, 38 insertions(+), 35 deletions(-)

diff --git a/.gitignore b/.gitignore
index e98eea3..adb525f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,6 @@
-# SPDX-FileCopyrightText: : Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+# SPDX-FileCopyrightText: : Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 # SPDX-License-Identifier: CC0-1.0
-# source: https://github.com/github/gitignore/blob/main/Python.gitignore
+# Source: https://github.com/github/gitignore/blob/main/Python.gitignore
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index fc28e5d..43b82ae 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: : Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+# SPDX-FileCopyrightText: : Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 # SPDX-License-Identifier: CC0-1.0
 
 # exclude webdevelopement build artefacts
diff --git a/.reuse/dep5 b/.reuse/dep5
index da1f454..d07f2c5 100644
--- a/.reuse/dep5
+++ b/.reuse/dep5
@@ -4,15 +4,15 @@ Upstream-Contact: Ludwig Hülk <https://github.com/Ludee>
 Source: https://github.com/rl-institut/super-repo
 
 Files: .github/*
-Copyright: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
-           Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
+Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+           Jonas Huber (jh-RLI) © Reiner Lemoine Institut
 License: CC0-1.0
 
 Files: docs/*
-Copyright: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
-           Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
+Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+           Jonas Huber (jh-RLI) © Reiner Lemoine Institut
 License: CC-BY-4.0
 
 Files: README.rst
-Copyright: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+Copyright: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 License: MIT
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a3dbc38..3a52f6e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 SPDX-License-Identifier: CC0-1.0
 -->
 
diff --git a/CITATION.cff b/CITATION.cff
index a51de06..89bd1bb 100644
--- a/CITATION.cff
+++ b/CITATION.cff
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 # SPDX-License-Identifier: CC0-1.0
 
 cff-version: 1.2.0
@@ -6,13 +6,18 @@ message: "If you use this software, please cite it using these metadata."
 authors:
   - family-names: "Hülk"
     given-names: "Ludwig"
-    alias: "@Ludee"
+    alias: "Ludee"
     affiliation: "Reiner Lemoine Institut"
     orcid: "https://orcid.org/0000-0003-4655-2321"
+  - family-names: "Huber"
+    given-names: "Jonas"
+    alias: "jh-rli"
+    affiliation: "Reiner Lemoine Institut"
+    orcid: "https://orcid.org/0000-0002-6234-0751"
 title: "Super Repo"
 type: software
 license: MIT
 version: 0.2.0
-doi:
+doi: null
 date-released: 2023-08-11
 url: "https://github.com/rl-institut/super-repo/"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1fda449..923b048 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 SPDX-License-Identifier: MIT
 
 [Homepage]: https://rl-institut.github.io/super-repo/
diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md
index 34102d3..ea7cd1e 100644
--- a/RELEASE_PROCEDURE.md
+++ b/RELEASE_PROCEDURE.md
@@ -1,5 +1,5 @@
 <!--
-SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 SPDX-License-Identifier: MIT
 
 [Homepage]: https://rl-institut.github.io/super-repo/
diff --git a/USERS.cff b/USERS.cff
index b32fb32..a57d5a1 100644
--- a/USERS.cff
+++ b/USERS.cff
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 # SPDX-License-Identifier: CC0-1.0
 
 cff-version: 1.2.0
diff --git a/mkdocs.yml b/mkdocs.yml
index 59059ea..3d0a619 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,11 +1,11 @@
-# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
-# SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
+# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
 # SPDX-License-Identifier: CC0-1.0
 
 # Project
 site_name: Super-Repo Documentation
 site_url: https://rl-institut.github.io/super-repo/
-site_description: Write your documentation in Markdown and create a static page for your developer and user community
+site_description: Documentation of the Super-Repo for scientific software
 
 # Repository
 repo_name: rl-institut/super-repo
diff --git a/requirements.txt b/requirements.txt
index f88a59b..b27af7c 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,5 +1,5 @@
-# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
-# SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
+# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
 mkdocs
diff --git a/super_repo/__init__.py b/super_repo/__init__.py
index 68bc6c0..49fd9df 100644
--- a/super_repo/__init__.py
+++ b/super_repo/__init__.py
@@ -4,7 +4,7 @@
 
 Examples for the calculater functionality to demonstrate TDD.
 
-SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
-SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
+SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 SPDX-License-Identifier: MIT
-"""
\ No newline at end of file
+"""
diff --git a/super_repo/example_calculator.py b/super_repo/example_calculator.py
index 1cb0bb0..0acbca7 100644
--- a/super_repo/example_calculator.py
+++ b/super_repo/example_calculator.py
@@ -4,8 +4,8 @@
 
 Examples for the calculater functionality to demonstrate TDD.
 
-SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
-SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
+SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 SPDX-License-Identifier: MIT
 """
 
diff --git a/super_repo/example_google.py b/super_repo/example_google.py
index 047308a..9dfde12 100644
--- a/super_repo/example_google.py
+++ b/super_repo/example_google.py
@@ -5,7 +5,8 @@
 
 SPDX-FileCopyrightText: Copyright (c) 2007-2023 by the Sphinx team
 SPDX-License-Identifier: BSD-2-Clause
-Source: https://github.com/sphinx-doc/sphinx/blob/master/doc/usage/extensions/example_google.py
+
+https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html
 
 This module demonstrates documentation as specified by the `Google Python
 Style Guide`_. Docstrings may extend over multiple lines. Sections are created
diff --git a/tests/test_example.py b/tests/test_example.py
index 5cf6120..2ad9e96 100644
--- a/tests/test_example.py
+++ b/tests/test_example.py
@@ -5,10 +5,7 @@
 Example implementation of common calculater functionality to
 demonstrate TDD.
 
-
-SPDX-FileCopyrightText: 2023 Jonas Huber <@jh-RLI>
-SPDX-FileCopyrightText: © Reiner Lemoine Institut
-
+SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
 SPDX-License-Identifier: MIT
 """
 
diff --git a/tox.ini b/tox.ini
index 71a0de6..b6e0086 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
-# SPDX-FileCopyrightText: Jonas Huber © Reiner Lemoine Institut <https://github.com/jh-RLI>
-# SPDX-FileCopyrightText: Ludwig Hülk © Reiner Lemoine Institut <https://github.com/Ludee>
+# SPDX-FileCopyrightText: Jonas Huber (jh-RLI) © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
 [tox]
@@ -44,7 +44,7 @@ commands_pre =
 commands =
     pytest --cov --cov-report=term-missing --cov-append --cov-config=.coveragerc --hypothesis-show-statistics {posargs}
 # after executing the pytest assembles the coverage reports
-commands_post = 
+commands_post =
     coverage report
     coverage html
     coverage xml
@@ -77,7 +77,7 @@ hang-closing = true
 ; D407 # Dont know what to do
 ; D406 # Dont know what to do
 ; D401 # Not suitable for example docstring names
-ignore = 
+ignore =
     W293
     W503
     D412
@@ -106,7 +106,7 @@ sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
 known_first_party = sampleproject
 # you should add here your known thirdparties, it will facilitate
 # the job to isort
-known_third_party = 
+known_third_party =
     hypothesis
     matplotlib
     numpy