search

yaroslavyaroslav / OpenAI-sublime-text

First class Sublime Text AI assistant with GPT-4o and llama.cpp support!
MIT License
130 stars 11 forks source link

Improve documentation of insert placeholder #4

Closed raineorshine closed 1 year ago

raineorshine commented 1 year ago

The default placeholder [insert] is not in the README. I had to look in the source code to figure out how to use OpenAI Insert.

This PR adds instructions to the README and provider better feedback to the user in the error message if the placeholder is missing.

yaroslavyaroslav commented 1 year ago

Thank you for you contribution, it helps a lot.

Just a comment: there's no placeholder in a readme, because it's actually in openAI.sublime-settings file, which is actually pretty well documented. But since you by some strange reason doesn't see it, there you are.

raineorshine commented 1 year ago

It's not such a strange reason! Usually people don't go to the settings to learn how to use a package. That’s precisely what the README is for.

yaroslavyaroslav commented 1 year ago

You've got me wrong. Strange is that default settings doesn't appeared at your side, not that this you did not study them instead of readme. I agree that the readme is far from it's perfect state so far, and grateful to you for your contribution.

raineorshine commented 1 year ago

Ahhhh, I see. Indeed 😁