sphinx-contrib / sphinx-contrib/autoprogram

Indents in multiline strings get rendered in manpage

Open
#44 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
48
Forks
24
Avg merge
2h 15m
Merged PRs (30d)
1

Description

Hi I just realised that #21 or at least something similiar appears to be still an issue in generated manpages. Not sure if it is related at all, just sounds familiar....didn't dig into any code.

eg

    search_subparser.add_argument(
        dest='release_search', metavar='search_terms',
        help="""
        The collection is searched for these terms. When offline, it
        searches through all releases' artists/titles only (eg tracknames
        not considered). When online, the Discogs API search
        ...
        """

produces in the manpage:

 positional arguments
       search_terms
              The collection is searched for these terms. When offline, it
                      searches through all releasesa artists/titles only (eg tracknames
                      not considered). When online, the Discogs API search
                      ...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS positional arguments
.INDENT 0.0
.TP
.B search_terms
The collection is searched for these terms. When offline, it
        searches through all releases’ artists/titles only (eg tracknames
        not considered). When online, the Discogs API search
        ...

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the generated manpage from the multiline argparse help text shown in the issue, then trace the manpage-generation path to find where continuation-line indentation is introduced. Done means the displayed help text preserves appropriate indentation consistently in the generated manpage, including both the indented and unindented examples shown.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.