From 9fef9fdecfecb08c724e125a325cca2f9aa48abf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 28 Feb 2025 16:55:33 +0100 Subject: [PATCH 1/3] refactor: :truck: rename `create_readme_text()` function to `build_()` --- src/seedcase_sprout/core/create_readme_text.py | 2 +- tests/core/test_create_readme_text.py | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/seedcase_sprout/core/create_readme_text.py b/src/seedcase_sprout/core/create_readme_text.py index 5fdd722f4..cb3d39a6c 100644 --- a/src/seedcase_sprout/core/create_readme_text.py +++ b/src/seedcase_sprout/core/create_readme_text.py @@ -12,7 +12,7 @@ TEMPLATES_PATH: Path = files("seedcase_sprout.core").joinpath("templates") -def create_readme_text(properties: PackageProperties) -> str: +def build_readme_text(properties: PackageProperties) -> str: """Creates a string containing the README text. Args: diff --git a/tests/core/test_create_readme_text.py b/tests/core/test_create_readme_text.py index 86d72a51e..d609d915a 100644 --- a/tests/core/test_create_readme_text.py +++ b/tests/core/test_create_readme_text.py @@ -1,4 +1,4 @@ -from seedcase_sprout.core.create_readme_text import create_readme_text +from seedcase_sprout.core.create_readme_text import build_readme_text from seedcase_sprout.core.properties import ( ContributorProperties, LicenseProperties, @@ -46,9 +46,9 @@ def test_creates_readme(): ), ], ) - assert create_readme_text(properties) + assert build_readme_text(properties) def test_creates_readme_with_empty_values(): """Should be able to create a README for an empty set of properties.""" - assert create_readme_text(PackageProperties()) + assert build_readme_text(PackageProperties()) From 9b659e9d6c1a60a29683cc20a0cfef76d91a53b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 28 Feb 2025 16:57:32 +0100 Subject: [PATCH 2/3] refactor: :truck: rename the `create_readme_text` module to `build_` --- .../core/{create_readme_text.py => build_readme_text.py} | 0 tests/core/test_create_readme_text.py | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename src/seedcase_sprout/core/{create_readme_text.py => build_readme_text.py} (100%) diff --git a/src/seedcase_sprout/core/create_readme_text.py b/src/seedcase_sprout/core/build_readme_text.py similarity index 100% rename from src/seedcase_sprout/core/create_readme_text.py rename to src/seedcase_sprout/core/build_readme_text.py diff --git a/tests/core/test_create_readme_text.py b/tests/core/test_create_readme_text.py index d609d915a..71ffbdd72 100644 --- a/tests/core/test_create_readme_text.py +++ b/tests/core/test_create_readme_text.py @@ -1,4 +1,4 @@ -from seedcase_sprout.core.create_readme_text import build_readme_text +from seedcase_sprout.core.build_readme_text import build_readme_text from seedcase_sprout.core.properties import ( ContributorProperties, LicenseProperties, From dfce83de58a0e677684fd448dcd46919dee55872 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 28 Feb 2025 16:58:21 +0100 Subject: [PATCH 3/3] test: :truck: rename file fit new function name --- .../{test_create_readme_text.py => test_build_readme_text.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename tests/core/{test_create_readme_text.py => test_build_readme_text.py} (100%) diff --git a/tests/core/test_create_readme_text.py b/tests/core/test_build_readme_text.py similarity index 100% rename from tests/core/test_create_readme_text.py rename to tests/core/test_build_readme_text.py