From a52d350f4fa93fb35c26d6478bae998f25f4fd9d Mon Sep 17 00:00:00 2001 From: Matt Love Date: Tue, 9 Jul 2019 23:48:16 -0700 Subject: [PATCH] :pencil: Add missing docstring --- hyperglass/render/__init__.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/hyperglass/render/__init__.py b/hyperglass/render/__init__.py index 0a6e0b3..adc20d1 100644 --- a/hyperglass/render/__init__.py +++ b/hyperglass/render/__init__.py @@ -108,6 +108,12 @@ interpret traceroute results, [click here]\ def generate_markdown(section, file_name): + """ + Renders markdown as HTML. If file_name exists in appropriate + directory, it will be imported and used. If not, the default values + will be used. Also renders the Front Matter values within each + template. + """ if section == "info": file = working_directory.joinpath(f"templates/info/{file_name}.md") defaults = default_info