Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

man page has blank description #295

Open
vassudanagunta opened this issue Mar 16, 2024 · 0 comments
Open

man page has blank description #295

vassudanagunta opened this issue Mar 16, 2024 · 0 comments

Comments

@vassudanagunta
Copy link
Contributor

vassudanagunta commented Mar 16, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant