I've taken a look at the examples provided in various man pages and they're pretty div

<a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/us

Add examples API about man HOT 1 CLOSED

rust-cli commented on July 22, 2024

Add examples API

from man.

Comments (1)

yoshuawuyts commented on July 22, 2024

@codesections this looks pretty good!

`text_before`

I think we could get away with renaming .text_before() to .text() or .plain() if we make it positional.

Example styles

The pass example has two different example styles:

Style 1

EXTENDED GIT EXAMPLE

        Here, we initialize new password store, create a git repository, and then manipulate and sync passwords. Make note of the
        arguments to the first call of pass git push; consult git-push(1) for more information.

        zx2c4@laptop ~ $ pass init [email protected]
        mkdir: created directory ‘/home/zx2c4/.password-store’
        Password store initialized for [email protected].

Style 2

SIMPLE EXAMPLES

        Initialize password store
                zx2c4@laptop ~ $ pass init [email protected]
                mkdir: created directory ‘/home/zx2c4/.password-store’
                Password store initialized for [email protected].

Do we think it's useful to support both? Given the popularity of tldr I'm inclined to say we should optimize for brevity, and only support "style 2" examples. Possibly even omitting the output and indentation to make it more similar to the tldr formatting. Thoughts?

from man.

Related Issues (17)

Recommend Projects