google/python-fire

parsing function help with multiline

Open

#448 opened on Apr 8, 2023

View on GitHub
 (30 comments) (0 reactions) (1 assignee)Python (1,418 forks)batch import
bughelp wanted

Repository metrics

Stars
 (26,214 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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

Contributor guide

Research direction
Investigate how Python Fire parses docstrings and formats help text, focusing on line break handling. Look at the parser logic for docstrings and the help formatter.
Tech stack
python
Domain
cli
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70