Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: 🚚 rename create_readme_text() to build_readme_text() #1099

Merged
merged 3 commits into from
Mar 4, 2025
Merged

refactor: 🚚 rename create_readme_text() to build_readme_text() #1099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9fef9fd
refactor: :truck: rename `create_readme_text()` function to `build_()`
signekb Feb 28, 2025
9b659e9
refactor: :truck: rename the `create_readme_text` module to `build_`
signekb Feb 28, 2025
dfce83d
test: :truck: rename file fit new function name
signekb Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...eedcase_sprout/core/create_readme_text.py → ...seedcase_sprout/core/build_readme_text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions tests/core/test_create_readme_text.py → tests/core/test_build_readme_text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from seedcase_sprout.core.create_readme_text import create_readme_text
from seedcase_sprout.core.build_readme_text import build_readme_text
from seedcase_sprout.core.properties import (
ContributorProperties,
LicenseProperties,
Expand Down Expand Up @@ -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())