google/python-fire

parsing function help with multiline

Open

#448 建立於 2023年4月8日

在 GitHub 查看
 (30 留言) (0 反應) (1 負責人)Python (26,214 star) (1,418 fork)batch import
bughelp wanted

描述

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).

貢獻者指南

技術棧
python
領域
cli
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PythonPython Fire basicsdocstring parsing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Investigate the help formatting logic in Python Fire, particularly how docstrings are extracted and displayed. Look at files such as fire/core.py or fire/formatting.py. Understand the existing multiline handling and modify the formatting to allow flexible line breaks.