Skip to content

Commit c6ff7e7

Browse files
authored
Change wording
1 parent 677f9ea commit c6ff7e7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/databricks/labs/lsql/dashboards.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def _parse_header(self, header: str) -> dict[str, str]:
8181
def split(self) -> tuple[str, str]:
8282
"""Split the file header from the content.
8383
84-
Returns
84+
Returns :
8585
str : The file header possibly containing arguments.
8686
str : The file contents.
8787
"""
@@ -133,14 +133,14 @@ class MarkdownHandler(BaseHandler):
133133
_FRONT_MATTER_BOUNDARY = re.compile(r"^-{3,}\s*$", re.MULTILINE)
134134

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

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

0 commit comments

Comments
 (0)