mccPeople who design APIs. I am begging you. It doesn't matter how "simple" or "intuitive" or "elegant" your API is. You need to include sample code.
Another thing I am begging of people who make APIs: When you include sample code in the docs, include the "using"/"use"/"import"/"#include" statements. Please. Please. I just pasted this inline sample code https://mlem.ellpeck.de/articles/ui.html#setting-it-up into my hello world program, and it's failing because the symbol "UntexturedStyle" could not be found. "Are you missing a using directive or an assembly reference?", asks dotnet. Yeah, probably?? because you didn't tell me what using directives I needed?!?
Meg@mcc God yes, especially c or c++ where there's almost never any relationship between the header file name and the type name and the compiler can rarely help you (recently I've run into this a lot with template specializations where the actual definition I need is in a different header than the declaration too).
@megmac C/C++ is a special hell because often you can import a symbol by *accident*. So code will work in one project and then you'll paste it into another and suddenly a critical symbol isn't found, because in the original project you included B.h which included A.h because nobody clearly told you in the first place you needed to include A.h.
James Widman@mcc @megmac clangd can help here: when you have LSP completion set up in your editor and you select (for example) a function 'foo' from the completion menu, if the header that declares 'foo' is not already included, clangd will auto-insert the appropriate `#include` directive at the same time that it inserts 'foo()'.
@mcc @megmac oh wait; you said "paste", in which case you don't get the popup menu...
However! In that case, clangd will offer auto-fixes (which insert the appropriate header) when you request a code-action[1][2] with the cursor at the point of the error.
[1] see textDocument/codeAction https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/
[2] usable e.g. in neovim with:
vim.keymap.set('n', '<A-f>', vim.lsp.buf.code_action, bufopts)