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

Add seq-based overload for Docopt.Parse #2525

Merged

Conversation

rmunn
Copy link
Contributor

@rmunn rmunn commented Jun 25, 2020

Description

Fix #2433 by adding an overload to Docopt.Parse that takes an IEnumerable<string>. All existing unit tests continue to pass after this PR.

TODO

Feel free to open the PR and ask for help

  • New (API-)documentation for new features exist (Note: API-docs are enough, additional docs are in help/markdown):

Help needed: there's no API documentation for Docopt yet, and as I tried to write it, I realized I don't quite know what to write to explain the main Parse() implementation.

  • unit or integration test exists (or short reasoning why it doesn't make sense):

Help needed: there are no unit tests for Docopt, and I don't feel up to writing them at the moment.

Note: Consider using the CreateProcess API which can be tested more easily, see https://github.com/fsharp/FAKE/pull/2131/files#diff-4fb4a77e110fbbe8210205dfe022389b for an example (the changes in the DotNet.Testing.NUnit module)

  • boy scout rule: "leave the code behind in a better state than you found it" (fix warnings, obsolete members or code-style in the places you worked in):

This is a one-line PR, so I didn't really look at any other code except the Docopt class, and I didn't see anything in the Docopt class that needed fixing.

  • (if new module) the module has been linked from the "Modules" menu, edit help/templates/template.cshtml, linking to the API-reference is fine.

N/A

  • (if new module) the module is in the correct namespace

N/A

  • (if new module) the module is added to Fake.sln (dotnet sln Fake.sln add src/app/Fake.*/Fake.*.fsproj)

N/A

@matthid
Copy link
Member

matthid commented Jun 27, 2020

Help needed: there are no unit tests for Docopt, and I don't feel up to writing them at the moment.

Ironically I think that's the component with the most tests ;)

In any case, thanks a lot :)

@matthid matthid merged commit 9b36420 into fsprojects:release/next Jun 27, 2020
@matthid matthid mentioned this pull request Jun 27, 2020
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.

Suggestion: Docopt.Parse overload that takes list rather than array
2 participants