Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: make plugin more verbose #123

Merged
merged 4 commits into from
Aug 30, 2021
Merged

fix: make plugin more verbose #123

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbee786
fix: make the plugin be more verbose
dandhlee Aug 27, 2021
e6f2e59
fix: include file path when necessary
dandhlee Aug 27, 2021
45aa1d7
fix: consolidate error message
dandhlee Aug 27, 2021
23b7566
fix: update to use string join
dandhlee Aug 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions docfx_yaml/extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ def extract_keyword(line):
except ValueError:
# TODO: handle reST template.
if line[3] != "_":
raise ValueError(f"Wrong formatting enoucntered for \n{line}\n Please check the docstring.")
raise ValueError(f"Wrong formatting enoucntered for \n{line}")
return line


Expand Down Expand Up @@ -399,7 +399,7 @@ def _parse_docstring_summary(summary):
parts = [split_part for split_part in part.split("\n") if split_part]
tab_space = len(parts[0]) - len(parts[0].lstrip(" "))
if tab_space == 0:
raise ValueError("Code in the code block should be indented. Please check the docstring.")
raise ValueError(f"Code in the code block should be indented. Please check the docstring: \n{summary}")
if not part.startswith(" "*tab_space):
# No longer looking at code-block, reset keyword.
keyword = ""
Expand Down Expand Up @@ -428,13 +428,16 @@ def _parse_docstring_summary(summary):
})

else:
print("Could not process the attribute. Please check the docstring in {summary}.")
print(f"Could not process the attribute. Please check the docstring: \n{summary}")

continue

# Parse keywords if found.
if part.startswith(".."):
keyword = extract_keyword(part)
try:
keyword = extract_keyword(part)
except ValueError:
raise ValueError(f"Please check the docstring: \n{summary}")
# Works for both code-block and code
if keyword and keyword in [CODE, CODEBLOCK]:
# Retrieve the language found in the format of
Expand Down Expand Up @@ -830,7 +833,15 @@ def _update_friendly_package_name(path):
# Extract summary info into respective sections.
if summary:
top_summary = _extract_docstring_info(summary_info, summary, name)
datam['summary'], datam['attributes'] = _parse_docstring_summary(top_summary)
try:
datam['summary'], datam['attributes'] = _parse_docstring_summary(top_summary)
except ValueError:
debug_line = []
if path:
debug_line.append(f"In file {path}\n")
debug_line.append(f"For module {module}, type {_type}:\n")
debug_line.append(f"Failed to parse docstring on {name}.")
raise ValueError("".join(debug_line))


# If there is no summary, add a short snippet.
Expand Down