nvim-lua
docs: Adds a paragraph about lua being a real programming language.
As proposed in #1376, I have written something up. I am open to discussion about it!
I like the idea of this but I think the text needs a bit of work.
There are some plurals where they should be singular etc.
Also, will this inspire or merely confuse new Neovim users?
Anyway thank you for your contribution!
If you accept my changes or suggest alternatives I'll merge this. Thanks for the contribution!
I appreciate the effort, thanks for providing the feedback. You should probably rebase the branch to get rid of all the additional commits. If you do not do this I'll gladly do it.
Honestly I find it confusing. I'm not quite sure what the purpose of including this text here is.
If I want to learn what Lua is, I'd search for it and I have the following search result on the top:
Additionally, after going through the examples, I believe the kickstart codebase is full of similar snippets.
Wouldn’t this be considered unnecessary noise in the documentation?
It is not so much about what lua is, but rather about communication that you can use lua with its full power. This is "somewhat obvious", but I feel like it is not written down sufficiently. Especially considering the script uses some of these powers later on. And I feel like providing this context will ease understanding later on.
@ro0gr Is there a change we could make that would make this more concise or impactful or do you think the whole idea needs to be rejected?
Thanks for participating everyone. I have no skin in this game, I already know Lua and am not a newbie so all opinions are helpful :)
@feoh That's a great question.
My main concern with this PR is the inclusion of random code snippets, which, on their own, aren't sufficient for a curious user to find the right answers. As I mentioned earlier, I believe the Kickstart project already provides a solid set of working examples for newcomers to explore.
Additionally, we're not leaving users alone with just raw Lua - we already offer some starting points, for example:
https://github.com/nvim-lua/kickstart.nvim/blob/d350db2449da40df003c40d440f909d74e2d4e70/init.lua#L35-L42
In my view, the best approach is to outsource deeper learning to external resources, rather than trying to inline educational content directly into comments. Unfortunately, I don't have a good list of links off the top of my head, maybe someone does?
However, I find the r/neovim community very helpful for this purpose. It might make sense to at least share a link to this and similar resources.
There's also already a reference to Lua being a real programming language:
https://github.com/nvim-lua/kickstart.nvim/blob/d350db2449da40df003c40d440f909d74e2d4e70/init.lua#L520-L521
@Weyaaron What do you think of the already existing references others have pointed out?
In my view this PR is superfluous. There's already enough helpful hints throughout the whole kickstart. People that will be interested in learning more about lua will be able to find numerous examples and documentation about it, no need to fit everything in kickstart, this can be a never ending story, there's always more that can be added.
@Weyaaron What do you think of the already existing references others have pointed out?
Sorry for the late reply, I appreciate the feedback/dialog. Given that multiple people have voiced concern I concede my point and retract the pr.