Skip to content

Commit

Permalink
Change wording
Browse files Browse the repository at this point in the history
  • Loading branch information
JCZuurmond committed Jun 19, 2024
1 parent 731ba7b commit 95f7297
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/databricks/labs/lsql/dashboards.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ def _parse_header(self, header: str) -> dict[str, str]:
def split(self) -> tuple[str, str]:
"""Split the file header from the content.
Returns
Returns :
str : The file header possibly containing arguments.
str : The file contents.
"""
Expand Down Expand Up @@ -155,14 +155,14 @@ class MarkdownHandler(BaseHandler):
_FRONT_MATTER_BOUNDARY = re.compile(r"^-{3,}\s*$", re.MULTILINE)

def _parse_header(self, header: str) -> dict[str, str]:
"""Markdown frontmatter header is a YAML."""
"""Markdown configuration header is a YAML."""
_ = self
return yaml.safe_load(header) or {}

def split(self) -> tuple[str, str]:
"""Split the markdown file header from the contents.
The header is enclosed by the boundaries (line with '---').
The header is enclosed by a horizontal line marked with three dashes '---'.
"""
splits = self._FRONT_MATTER_BOUNDARY.split(self._content, 2)
if len(splits) == 3:
Expand Down

0 comments on commit 95f7297

Please sign in to comment.