[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Wget-dev] [docs] Suggestion: Using --long-flags in documentation

From: Nemo
Subject: [Wget-dev] [docs] Suggestion: Using --long-flags in documentation
Date: Tue, 4 Dec 2018 14:45:56 +0530
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:64.0) Gecko/20100101 Thunderbird/64.0


While the wget man page is very detailed, and the one-page-manual is great, there are lots of places in the documentation[0] where it uses short flags. For eg (from the --page-requisites section):

> this author likes to use a few options in addition to ‘-p’:
> wget -E -H -k -K -p http://site/document

In order for a reader to understand that invocation, it becomes a game of search and hunt. To make this worse, most modern browsers don't give an option of doing a case-sensitive search, so searching for -k vs -K is pretty difficult as well.

As a suggestion, I propose that we only use --long-flags in all examples used within the docs. I picked this up from a Changelog.com suggestion on scripting[1] and I think it applies equally well to documentation.

One fix might be to show long flags on hover in the HTML docs wherever it is used. Could be accomplished by abusing `<abbr>` so that we don't use JS.

I will gladly take this up if folks here agree.


[0]: https://www.gnu.org/software/wget/manual/wget.html
[1]: https://changelog.com/posts/use-long-flags-when-scripting

reply via email to

[Prev in Thread] Current Thread [Next in Thread]