Skip to content

Correct bug in _torch_docs.py that truncates docstrings. #8061

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

Merged
soumith merged 1 commit into from
Jun 4, 2018
Merged

Correct bug in _torch_docs.py that truncates docstrings. #8061

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions torch/_torch_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
"""Adds docstrings to functions defined in the torch._C"""

import re

import torch._C
from torch._C import _add_docstr as add_docstr

Expand All @@ -14,8 +16,9 @@ def parse_kwargs(desc):
'weight (Tensor): a weight tensor\n Some optional description'
}
"""
# Split by indents. Assumes each arg starts on a new line with 4 spaces.
kwargs = [section.strip() for section in desc.split('\n ')]
# Split on exactly 4 spaces after a newline
regx = re.compile("\n\s{4}(?!\s)")
kwargs = [section.strip() for section in regx.split(desc)]
kwargs = [section for section in kwargs if len(section) > 0]
return {desc.split(' ')[0]: desc for desc in kwargs}

Expand Down