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

Format commands help #639

Merged
merged 28 commits into from
Feb 23, 2015
Merged

Conversation

theimowski
Copy link
Member

This is supposed to auto generate command line help usage for each command, as well as auto generate the command line invocation in markdown.

It's still WIP, as some more commands are left to migrate to new approach

Feedback welcome

@forki
Copy link
Member

forki commented Feb 21, 2015

/cc @mexx

| Project(_) -> "Allows to add the package to a single project only."
| Force -> "Forces the download and reinstallation of all packages."
| Interactive -> "Asks the user for every project if he or she wants to add the package to the projects's paket.references file."
| Hard -> "Replaces package references within project files even if they are not yet adhering to to Paket's conventions (and hence considered manually managed)."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix typo: adhering to the Paket's

@mexx
Copy link
Member

mexx commented Feb 21, 2015

Good job @theimowski

@forki
Copy link
Member

forki commented Feb 22, 2015

the red appyveyor test should be gone after rebase.

@@ -34,7 +34,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{8E6D
docs\content\index.md = docs\content\index.md
docs\content\lock-file.md = docs\content\lock-file.md
docs\content\nuget-dependencies.md = docs\content\nuget-dependencies.md
docs\content\paket-config-file.md = docs\content\paket-config-file.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this gone?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, I treat config as a command so it's now generated from the HelpTexts class.
Eventually we'll be able to fallback to separate md file for each command when this PR is merged

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool. just tell me when it's ready to merge - really cool stuff

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, I think it's ready now - I took it even a step further.

@@ -130,7 +198,12 @@ type PackArgs =
| [<CustomCommandLine("releaseNotes")>] ReleaseNotes of string
with
interface IArgParserTemplate with
member __.Usage = ""
member this.Usage =
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mavnn could you please review the messages for this new command?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@theimowski theimowski changed the title [WIP] Format commands help Format commands help Feb 22, 2015
@forki
Copy link
Member

forki commented Feb 23, 2015

tumblr_inline_njhdq1yxtk1raprkq

forki added a commit that referenced this pull request Feb 23, 2015
@forki forki merged commit 4169e9c into fsprojects:master Feb 23, 2015
@theimowski theimowski deleted the format_command_help branch February 23, 2015 08:57
@forki
Copy link
Member

forki commented Feb 23, 2015

Just tested it. Looks great. Thanks so much.

@theimowski
Copy link
Member Author

Thanks good to hear that

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.

4 participants