Giter Club home page Giter Club logo

Comments (6)

joelim-work avatar joelim-work commented on August 16, 2024 1

Yeah I guess I can see the argument for having help as the entry point for looking up documentation.

There are some approaches (not an exhaustive list):

  • Map help to lf -help
  • Rename doc to help
  • Map both doc and help to lf -doc

Changing this would be pretty easy, but I think it's better to see if anyone else has any comments before doing anything - I'm somewhat unwilling to make such a decision on my own.

from lf.

joelim-work avatar joelim-work commented on August 16, 2024

I did a quick search of the history, it was added to address #100 so you can have a look at it for more details.

Regarding the name choice, I guess doc was chosen to reflect the difference between the -doc and -help command line flags, where the lf -doc displays the full documentation, but lf -help displays only the basic command line usage.

from lf.

jpggithub avatar jpggithub commented on August 16, 2024

Thanks for the history ;-)
A new help command could display the same text than lf -help and also indicate that a "longer" version can be obtain with the doc command.

from lf.

jpggithub avatar jpggithub commented on August 16, 2024

The command doc could also be simply listed with the other commands that have a default shortcut.
Currently, it is only indicated at the top of the documentation. In a first view, I hadn't see it at the top of the documentation because I'm simply "searching (to quickly perhaps ;-) what are the available commands".

from lf.

jpggithub avatar jpggithub commented on August 16, 2024

No problem!

from lf.

gokcehan avatar gokcehan commented on August 16, 2024

Maybe it was a mistake to use the name doc instead of help but I'm not sure if it is worth a breaking change at this point. The other two options (i.e. help for lf -help or doc) sounds more plausible to me. At some point, I had also considered adding a help command with a search argument by default to resemble the behavior in vim (e.g. cmd help $lf -doc | less +/$1), but I wasn't sure it was a good idea so I eventually forgot.

from lf.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.