Giters

chmln / sd

Intuitive find & replace CLI (sed alternative)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

man page has blank description

vassudanagunta opened this issue · comments

commented

Top of the current man page:

sd(1)                                                               General Commands Manual                                                              sd(1)

NAME
       sd

SYNOPSIS
       sd [-p|--preview] [-F|--fixed-strings] [-n|--max-replacements] [-f|--flags] [-h|--help] [-V|--version] <FIND> <REPLACE_WITH> [FILES]

DESCRIPTION
OPTIONS
       -p, --preview
              Display changes in a human reviewable format (the specifics of the format are likely to change in the future)

       -F, --fixed-strings
              Treat FIND and REPLACE_WITH args as literal strings

My understanding is that the sd man page is generated from the same source that populates sd --help, so perhaps the description that appears in the latter was overlooked in the mappings for the former:

sd v1.0.0
An intuitive find & replace CLI

Usage: sd [OPTIONS] <FIND> <REPLACE_WITH> [FILES]...

Arguments:
  <FIND>
          The regexp or string (if using `-F`) to search for

On the other hand, while the short and sweet "An intuitive find & replace CLI" is perfect for sd --help, where the user should already know what sd is for, I think the man page should have a more detailed description.

See man pages for git, less, wget, and of course sed and awk. See also sd's own git README.