Replaced fixed reference_section parameters with general additional_section parameters

Author: h-chmeruk

copier.yml

@@ -24,15 +24,20 @@ project_installation_instructions:
     type: str
     help: "A short description of how to install the package. It will be added to the README.md of this project"
 
-add_reference_section:
+add_additional_section:
   type: bool
-  help: "Do you want to add a reference section to the README.md?"
+  help: "Do you want to add an additional section to the README.md?"
   default: false
 
-reference_section_description:
-  when: "{{ add_reference_section }}"
+additional_section_heading:
+  when: "{{ add_additional_section }}"
   type: str
-  help: "Enter the references for the reference section."
+  help: "Enter the heading for the additional section."
+
+additional_section_description:
+  when: "{{ add_additional_section }}"
+  type: str
+  help: "Enter the description for the additional section."
 
 git_username:
     type: str

template/README.md.jinja

@@ -29,9 +29,9 @@ If the installation fails, please check out the [help section](https://pyfar-gal
 
 Check out the [contributing guidelines](https://{{ project_slug }}.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar.
 
-{% if add_reference_section == true -%}
-## References
+{% if add_additional_section == true -%}
+## {{ additional_section_heading }}
 
-{{ reference_section_description }}
+{{ additional_section_description }}
 
 {%- endif %}

tests/conftest.py

@@ -6,9 +6,10 @@ def copier_project_defaults():
         "project_slug": "my_project",
         "project_long_description": "my_project_description",
         "project_getting_started": "This is how to get started.",
-        "add_reference_section": "Y",
+        "add_additional_section": "Y",
         "project_installation_instructions": "Installation instructions.",
-        "reference_section_description": "Reference section description.",
+        "additional_section_heading": "Additional Section",
+        "additional_section_description": "Additional section description.",
         "git_username": "pyfar",
         "minimum_python_version": "3.11",
         "license": "MIT",

tests/test_copier.py

@@ -49,7 +49,7 @@ def test_generated_file_exists(default_project, file_name):
     "https://my_project.readthedocs.io/en/stable/contributing.html",
     "\nThis is how to get started.\n",
     "\nInstallation instructions.\n",
-    "\n\n## References\n\nReference section description.",
+    "\n\n## Additional Section\n\nAdditional section description.",
 ])
 def test_content_readme(default_project, desired):
     content = default_project.project_dir.joinpath("README.md").read_text()