parsing function help with multiline
hermanzhaozzzz opened this issue · 30 comments
hermanzhaozzzz commented
Can I have flexible line breaks in the help comments?
this is the help doc
def func(input_table: str):
"""Plot region mutation info using table generated by `bioat bam mpileup_to_table`.
:param input_table: Path of table generated by `bioat bam mpileup_to_table`.
This table should contain base mutation information from a short genome region (no more than 1k nt).
printed help I got
POSITIONAL ARGUMENTS
INPUT_TABLE
Type: str
Path of table generated by `bioat bam mpileup_to_table`. This table should contain base mutation information from a short genome region (no more than 1k nt).
printed help I expacted
POSITIONAL ARGUMENTS
INPUT_TABLE
Type: str
Path of table generated by `bioat bam mpileup_to_table`.
This table should contain base mutation information from a short genome region (no more than 1k nt).
dbieber commented
The docstring parsing code is in https://github.com/google/python-fire/blob/master/fire/docstrings.py
Multiline rst args should be handled by
python-fire/fire/docstrings.py
Lines 468 to 469 in d44d33d
You may have identified a bug.