dtomlinson/tembo-core
1
0
Fork 0
mirror of https://github.com/tembo-pages/tembo-core.git synced 2025-12-22 05:35:43 +00:00
Code Issues Projects Releases Wiki Activity

docs: clarify docstrings

Browse Source
This commit is contained in:
Daniel Tomlinson
2022-01-08 04:57:48 +00:00
parent f3e7555a2b
commit 89de31998b
2 changed files with 4 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
tembo/cli/cli.py
View File

@@ -201,7 +201,7 @@ def cli_message(message: str) -> None:
Relay a message to the user using the CLI. Relay a message to the user using the CLI.
Args: Args:
message (str): THe message to be displayed. message (str): The message to be displayed.
""" """
click.echo(f"[TEMBO] {message} 🐘") click.echo(f"[TEMBO] {message} 🐘")

9
tembo/journal/pages.py
View File

@@ -58,7 +58,7 @@ class PageCreator:
This factory is an abstract base class and should be implemented for each This factory is an abstract base class and should be implemented for each
[Page][tembo.journal.pages.Page] type. [Page][tembo.journal.pages.Page] type.
The private methods The methods
- `_check_base_path_exists()` - `_check_base_path_exists()`
- `_convert_base_path_to_path()` - `_convert_base_path_to_path()`
@@ -415,8 +415,6 @@ class ScopedPage(Page):
A page that uses substitute tokens. A page that uses substitute tokens.
Attributes: Attributes:
path (pathlib.Path): a [Path][pathlib.Path] object of the page's filepath including the
filename.
page_content (str): the content of the page from the template. page_content (str): the content of the page from the template.
""" """
@@ -462,9 +460,8 @@ class ScopedPage(Page):
Save the scoped page to disk and write the `page_content`. Save the scoped page to disk and write the `page_content`.
Raises: Raises:
exceptions.ScopedPageAlreadyExists: If the page already exists a exceptions.ScopedPageAlreadyExists: Raises
[ScopedPageAlreadyExists][tembo.exceptions.ScopedPageAlreadyExists] exception [ScopedPageAlreadyExists][tembo.exceptions.ScopedPageAlreadyExists] if the page already exists.
is raised.
Returns: Returns:
tembo.utils.Success: A [Success][tembo.utils.__init__.Success] with the path of the tembo.utils.Success: A [Success][tembo.utils.__init__.Success] with the path of the