Skip to content

Commit

Permalink
Doc styler tip (huggingface#15105)
Browse files Browse the repository at this point in the history
* Add new lines before/after tips

* Check end of lines
  • Loading branch information
sgugger authored Jan 11, 2022
1 parent 68d9251 commit 704d1fe
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion utils/style_doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
_re_returns = re.compile("^\s*Returns?:\s*$")
# Matches the special tag to ignore some paragraphs.
_re_doc_ignore = re.compile(r"(\.\.|#)\s*docstyle-ignore")

# Re pattern that matches <Tip>, </Tip> and <Tip warning={true}> blocks.
_re_tip = re.compile("^\s*</?Tip(>|\s+warning={true}>)\s*$")

DOCTEST_PROMPTS = [">>>", "..."]

Expand Down Expand Up @@ -275,6 +276,8 @@ def style_docstring(docstring, max_len):
new_paragraph = new_paragraph or list_search is not None
# Code block beginning
new_paragraph = new_paragraph or code_search is not None
# Beginning/end of tip
new_paragraph = new_paragraph or _re_tip.search(line)

# In this case, we treat the current paragraph
if not in_code and new_paragraph and current_paragraph is not None and len(current_paragraph) > 0:
Expand Down Expand Up @@ -318,6 +321,14 @@ def style_docstring(docstring, max_len):
elif _re_args.search(line):
new_lines.append(line)
param_indent = find_indent(lines[idx + 1])
elif _re_tip.search(line):
# Add a new line before if not present
if not is_empty_line(new_lines[-1]):
new_lines.append("")
new_lines.append(line)
# Add a new line after if not present
if idx < len(lines) - 1 and not is_empty_line(lines[idx + 1]):
new_lines.append("")
elif current_paragraph is None or find_indent(line) != current_indent:
indent = find_indent(line)
# Special behavior for parameters intros.
Expand Down

0 comments on commit 704d1fe

Please sign in to comment.