-
-
Notifications
You must be signed in to change notification settings - Fork 85
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
Added reformat action to public api #2358
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! I don't think we need tests, because the talon action is already tested
- Would be good to add an example to the docs of how to use it in a command which takes a formatter via spoken form
I was planning to do that, but I can't find anywhere in our documentation where we have "recipes". Where should I place this? EDIT: I've added an example to the customization file: cursorless/docs/user/customization.md Lines 186 to 194 in e18c727
|
@pokey I don't like that precommit removes trailing whitespaces from markdown files. I prefer to have it as two separate lines. |
## Checklist - [/] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [x] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [x] I have not broken the cheatsheet --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
You can use a backslash to hard line break in Markdown: https://spec.commonmark.org/0.31.2/#hard-line-breaks |
Sorry I'm not following. Why do you want the trailing whitespace? |
Ah right I wasn't familiar with that syntax. And yeah I'd def go for the backslash if you want a hard line break. Although I'll generally always just go for two new lines to give a paragraph break. Eg that's what I would have done here |
I've always used the syntax with trailing whitespaces for new lines, but of course since it's markdown you can do everything multiple ways :p |
Checklist