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

Docstring description multiline parsing #476

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Docstring description multiline parsing #476

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
45e3a0e
quick fix
thebadcoder96 Dec 21, 2023
b395e20
Added '\n' to _join_lines() and updated tests
thebadcoder96 Dec 23, 2023
6f0ce18
cleaned py file
thebadcoder96 Dec 23, 2023
4b770d9
Added changes based on discussion
thebadcoder96 Jan 2, 2024
93ff111
updated code to resolved comment
thebadcoder96 Jan 2, 2024
645c51d
Changed threshold to 40%
thebadcoder96 Jan 2, 2024
eb8694f
Merge branch 'google:master' into docstring-description-parsing
thebadcoder96 Jan 2, 2024
c56d951
Added test cases
thebadcoder96 Jan 3, 2024
446065d
Updated code to per-arg state
thebadcoder96 Jan 14, 2024
2458562
Updated to per-arg state
thebadcoder96 Jan 14, 2024
5ce7726
made code more robust and added test cases (handling :)
thebadcoder96 Jan 14, 2024
794f48e
Updated sttring comparison to index
thebadcoder96 Jan 14, 2024
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
Prev Previous commit
Next Next commit
cleaned py file
  • Loading branch information
@thebadcoder96
thebadcoder96 committed Dec 23, 2023
commit 6f0ce182e17260b0b2237da94f5dd8053c1ca70c
4 changes: 2 additions & 2 deletions fire/docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ def parse(docstring):

args.extend([KwargInfo(
name=arg.name, type=_cast_to_known_type(_join_lines(arg.type.lines)),
description=_join_lines(arg.description.lines, 'description')) for arg in state.kwargs])
description=_join_lines(arg.description.lines)) for arg in state.kwargs])

return DocstringInfo(
summary=summary,
Expand Down Expand Up @@ -239,7 +239,7 @@ def _is_blank(line):
return not line or line.isspace()


def _join_lines(lines, type=None):
def _join_lines(lines):
"""Joins lines with the appropriate connective whitespace.

This puts a single space between consecutive lines, unless there's a blank
Expand Down