Skip to content

Commit

Permalink
refactor: 🚚 rename create_readme_text() to build_readme_text() (#…
Browse files Browse the repository at this point in the history
…1099)

## Description

To fit the #810 and the current [naming
scheme](https://sprout.seedcase-project.org/docs/design/architecture/naming#actions).

<!-- Select quick/in-depth as necessary -->
This PR needs a quick review.

## Checklist

- [X] Added or updated tests
- [X] Ran `just run-all`
  • Loading branch information
signekb authored Mar 4, 2025
1 parent 67b4239 commit 9204b9d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
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
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())

0 comments on commit 9204b9d

Please sign in to comment.