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 examples to patch's help #3075

Merged
merged 1 commit into from May 27, 2022
Merged

Add examples to patch's help #3075

merged 1 commit into from May 27, 2022

Conversation

plumenator
Copy link
Contributor

@plumenator plumenator commented May 18, 2022

Close #3030

@ceedubs
Copy link
Contributor

ceedubs commented May 24, 2022

Thanks a lot for the PR, @plumenator!

I think that there should be an example for the no-arg version that uses the default patch in the current namespace.

It's news to me that you can also pass in a namespace. That's a thing @aryairani? If so, should the example not have the square braces in [path] since this is the example where path is being provided and there's another example where it's not?

@plumenator
Copy link
Contributor Author

The patch arg is required. As for the path example, I followed the todo example:

( makeExample todo ["<patch>", "[path]"],

Copy link
Contributor

@ceedubs ceedubs left a comment

Choose a reason for hiding this comment

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

@plumenator sorry I think that I was confused both in my comment on this PR and in the original issue that I created. Thanks for setting me straight and for fixing the docs!

@ceedubs ceedubs merged commit 27cba74 into unisonweb:trunk May 27, 2022
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.

patch help should describe optional argument
2 participants