Document shiftwidth/softtabstop/tabstop caveat about nvim-lua-guide

[nanotee]

You're right, this is useful information, at least until vim.opt lands in core. I've added some info in #55

[nanotee]

This used to be documented on an older commit: https://github.com/nanotee/nvim-lua-guide/blob/f37a52e4e108d72eb0903376ec486b371ea1c689/README.md#caveats-3

I decided to delete it because I wasn't 100% confident this was the right explanation and I didn't want to accidentally spread misinformation. I can restore it if you think it's still useful

As a side note, there's a PR that adds vim.opt as a convenience wrapper around Vim options and behaves a lot like the :set command, but it hasn't been merged yet. It should make it much easier to configure Neovim in Lua

[itmecho]

Ah fair enough. Probably best not to if we're not sure on the reason behind it.

I'll keep an eye on that PR, thanks!

[matu3ba]

Is this merged here or what kind of explanations do you want to make? linking the issues?

[ibraheemdev]

I just spent half an hour figuring out why my tabstops and undo directory was not being set, and stumbled across this issue after fixing it by setting vim.o and vim.bo 😢 I think it would be very helpful to include some information about this, even if you are not 100% sure about the reason.