Warn users if he uses tool without associated variables

[ilan-schemoul]

For hours I was puzzled as to why when I asked use @editor to modify /file it didn't work. I thought LLM was struggling or plugin was broken (buffer 1 is not modifiable etc.). Actually I just used it wrong @editor goes in hands with #buffer and @files with /files
Obviously in hindsight it's extremely obvious and feel stupid but I expect as thoushand use your plugin than some will also waste hours (and as LLMs can often produce output whatever happens, even if input sucks, it's super hard to debug imo).
My kind suggestions:

• Add doc
• Detect via simple code that it might be an error if user uses editor tool with no buffer, or file tool with no file variables
  Again, it feels stupid and obvious in hindsight, but you know when you try a new tool, with new LLMs (the ones at work are really limited in terms of parameter with current HW) and you just don't know what's up you can waste hours and be frustrated. So any help to help people who make stupid mistakes would be awesome.
  thanks for the great tool

[olimorris]

This is explicitly called out in the docs:

The @editor tool enables an LLM to modify the code in a Neovim buffer. If a buffer's content has been shared with the LLM then the tool can be used to add, edit or delete specific lines. Consider pinning or watching a buffer to avoid manually re-sending a buffer's content to the LLM:

Use the @editor tool refactor the code in #buffer{watch}

Can you apply the suggested changes to the buffer with the @editor tool?

[ilan-schemoul]

I understand it seems very clear (and it is for some people) but I believe adding a sentence about the #file variable being different from #buffer would be helpful to some.
Like "@editor only works with the #buffer variable. It does not support #files"
It's up to you, I'm sure 90% of user would not be as dumb as me but 10% of 10K users is already 1K people wasting collectively thousands of hours. Adding one sentence is worth

[olimorris]

The file is not a variable, it's a slash command. There is no such thing as #files.

[olimorris]

Detect via simple code that it might be an error if user uses editor tool with no buffer,

I appreciate the sentiment of your ask. Unfortunately, coding and anticipating what users might do is a rather fruitless endeavour. There are a significant number of features that I could be working in CodeCompanion on that would be adding huge value to developers by enabling them to build faster. Your types of requests are not those, unfortunately.

I would thoroughly recommend reading the docs if you find yourself struggling. I have spent countless hours making them as detailed as possible to avoid users having to raise issues or ask questions in the discussions.

[ilan-schemoul]

I expected that kind of answer and respect it. I understand that for the people who himself wrote the code and doc he cannot appreciate why some things that seem obvious can a few people.
Every user reading entire doc and understanding every bit won't happen. But alright I expected that answer