Merge pull request #38 from fhoussiau/main

Add module docstring
vemel · Oct 1, 2024 · 26f346c · 26f346c
2 parents ed6f6ea + 4f3eb3d
commit 26f346c
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 7 deletions.
diff --git a/handsdown/md_document.py b/handsdown/md_document.py
@@ -1,6 +1,7 @@
 """
 Markdown file builder.
 """
+
 import re
 import traceback
 from pathlib import Path
@@ -86,7 +87,7 @@ def __exit__(
     @property
     def source_file_name(self) -> str:
         """
-        Source cide file name.
+        Source code file name.
         """
         return self.source_code_url.split("/")[-1]
 

diff --git a/handsdown/templates/common/class.md.jinja2 b/handsdown/templates/common/class.md.jinja2
@@ -2,9 +2,9 @@
 
 [Show source in {{ md_document.source_file_name }}:{{ class.line_number }}]({{ md_document.source_code_url }}#L{{ class.line_number }})
 
-{% for attrubute in class.get_documented_attribute_strings() -%}
+{% for attribute in class.get_documented_attribute_strings() -%}
 {% if loop.first -%}{{ "#### Attributes\n" -}}{% endif -%}
-{{ "\n- " }}{{ attrubute }}
+{{ "\n- " }}{{ attribute }}
 {% if loop.last -%}{{ "\n\n" -}}{% endif -%}
 {% endfor -%}
 

diff --git a/handsdown/templates/material/module.md.jinja2 b/handsdown/templates/material/module.md.jinja2
@@ -1,5 +1,7 @@
 # {{ module_record.title }}
 
+{{ module_record.docstring }}
+
 [{{ generator.md_index.title }}]({{ md_document.get_doc_link(generator.md_index.path) }}#{{ md_document.get_anchor(generator.md_index.title) }}) /{{ ' ' -}}
 {% for parent_import_string in module_record.import_string.get_parents() -%}
     {% set parent_module_record = generator.module_records.find_module_record(parent_import_string) -%}
@@ -20,8 +22,8 @@
 
 {% if module_record.get_documented_attribute_strings() -%}
 #### Attributes
-{% for attrubute in module_record.get_documented_attribute_strings() -%}
-{{ "\n- " }}{{ attrubute }}
+{% for attribute in module_record.get_documented_attribute_strings() -%}
+{{ "\n- " }}{{ attribute }}
 {% endfor -%}
 {{ "\n\n" -}}
 {% endif -%}

diff --git a/handsdown/templates/readthedocs/module.md.jinja2 b/handsdown/templates/readthedocs/module.md.jinja2
@@ -1,5 +1,7 @@
 # {{ module_record.title }}
 
+{{ module_record.docstring }}
+
 [{{ generator.md_index.title }}]({{ md_document.get_doc_link(generator.md_index.path) }}#{{ md_document.get_anchor(generator.md_index.title) }}) /{{ ' ' -}}
 {%- for parent_import_string in module_record.import_string.get_parents() -%}
     {% set parent_module_record = generator.module_records.find_module_record(parent_import_string) -%}
@@ -20,8 +22,8 @@
 
 {% if module_record.get_documented_attribute_strings() -%}
 #### Attributes
-{% for attrubute in module_record.get_documented_attribute_strings() -%}
-{{ "\n- " }}{{ attrubute }}
+{% for attribute in module_record.get_documented_attribute_strings() -%}
+{{ "\n- " }}{{ attribute }}
 {% endfor -%}
 {{ "\n\n" -}}
 {% endif -%}