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

Better document that each shortcut needs to a function (or wrapped in one) #25

Open
gadenbuie opened this issue Mar 25, 2024 · 1 comment

Comments

@gadenbuie
Copy link
Owner

Fortunately, the fix is pretty easy. Each shortcut needs to be encapsulated in a function. The doesn't need to be a named, but it helps and I recommend it:

Hey, @gadenbuie 👋
Maybe you can add this into the README file or in the Get Started section? I have also encountered this issue. Unfortunately, it's not really straightforward from the package documentation that it's better to wrap all shortcuts in functions :(

Originally posted by @atsyplenkov in #24 (comment)

@gadenbuie
Copy link
Owner Author

gadenbuie commented Mar 25, 2024

The quick start guide includes this instruction, but it's a little too opaque and the following example shows a packaged function rather than a user-created function.

Each shortcut should look something like the example below,
but you can include _any R code you want_ as the shortcut,
as long as it's a function.

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

No branches or pull requests

1 participant