diff --git a/rendercv/__init__.py b/rendercv/__init__.py index e243e2b..4d544bf 100644 --- a/rendercv/__init__.py +++ b/rendercv/__init__.py @@ -1,8 +1,8 @@ -r"""RenderCV package. +"""RenderCV package. It parses the user input YAML/JSON file and validates the data (checking spelling mistakes, whether the dates are consistent, etc.). Then, with the data, it creates a -$\LaTeX$ file and renders it with [TinyTeX](https://yihui.org/tinytex/). +$\\LaTeX$ file and renders it with [TinyTeX](https://yihui.org/tinytex/). """ import logging import os diff --git a/rendercv/__main__.py b/rendercv/__main__.py index 496ccc4..12a2c5b 100644 --- a/rendercv/__main__.py +++ b/rendercv/__main__.py @@ -1,7 +1,7 @@ import os import logging import re -from typing import Annotated +from typing import Annotated, Callable from functools import wraps from .rendering import read_input_file, render_template, run_latex @@ -20,13 +20,13 @@ app = typer.Typer( ) -def user_friendly_errors(func): +def user_friendly_errors(func: Callable) -> Callable: """Function decorator to make Pydantic's error messages more user-friendly. Args: - func (function): Function to decorate + func (Callable): Function to decorate Returns: - function: Decorated function + Callable: Decorated function """ @wraps(func) def wrapper(*args, **kwargs): @@ -121,6 +121,7 @@ def new(name: Annotated[str, typer.Argument(help="Full name")]): with open(file_name, "w", encoding="utf-8") as file: file.write(new_input_file) + logger.info(f"New input file created: {file_name}") def cli(): """Start the CLI application.