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

Show command help on --help - relates to #433 #437

Merged
merged 4 commits into from
Dec 9, 2014
Merged

Show command help on --help - relates to #433 #437

merged 4 commits into from
Dec 9, 2014

Conversation

forki
Copy link
Member

@forki forki commented Dec 8, 2014

No description provided.

@forki
Copy link
Member Author

forki commented Dec 8, 2014

/cc @haf @agross

@agross
Copy link
Contributor

agross commented Dec 8, 2014

Looks good, but :)

  • Markdown in the console output:
$ paket add --help
Paket version 0.17.19.0
# paket add

Adds a new package to your [`paket.dependencies` file](dependencies-file.html).

    [lang=batchfile]
    $ paket add nuget PACKAGENAME [version VERSION] [--interactive] [--force] [--hard]
  • paket without parameters still has that strange commands-on-top, parameters-at-the-bottom layout.

But we're getting there!

@forki
Copy link
Member Author

forki commented Dec 8, 2014

yeah now we need ideas how to improve this ;-)

@agross
Copy link
Contributor

agross commented Dec 8, 2014

Does your markdown lib support rendering to text?

@forki
Copy link
Member Author

forki commented Dec 8, 2014

@tpetricek's FSharp.Formatting uses Razor for the output. So probably yes.

@forki
Copy link
Member Author

forki commented Dec 8, 2014

maybe we just split the stuff into cmd text and "additional" docs.

@tpetricek
Copy link
Member

F# Formatting doesn't currently have text output, but it sounds like a fun project. I'm sure we could find a contributor for that. It's just a matter of walking over the AST

@forki
Copy link
Member Author

forki commented Dec 9, 2014

At the moment I'm trying to come up with a simpler solution which doesn't need to reference FSharp.Formatting.

forki added a commit that referenced this pull request Dec 9, 2014
Show command help on --help - relates to #433
@forki forki merged commit 9a3d7a5 into master Dec 9, 2014
@forki forki deleted the help branch December 9, 2014 11:54
@forki
Copy link
Member Author

forki commented Dec 9, 2014

It's already progress. We will improve along the way.

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

Successfully merging this pull request may close these issues.

3 participants