Comment and documentation improvement #3943
Conversation
Thanks for the hint. I fixed the problem. |
a new file named 'cursor_c_lua.ldoc' which uses awesome comments syntax, because the existing 'cursor_c.ldoc' could not be compiled.
docs/common/cursor_c_lua.ldoc
Outdated
| @@ -0,0 +1,80 @@ | |||
| -- <div class='flex-list'> | |||
There was a problem hiding this comment.
This file should be named cursor.ldoc. the _c is to indicate the comments syntax is C style instead of Lua.
There was a problem hiding this comment.
So, should the files /docs/common/client_theme.ldoc and /docs/common/cobject.ldoc have the _c suffix too?
There was a problem hiding this comment.
Fair point. Let's just ignore my comment then because making these filenames more consistent is out of the scope of this PR 🤷
There was a problem hiding this comment.
Ah you did the change for this file anyway. Nice 👍
There was a problem hiding this comment.
Ah you did the change for this file anyway. Nice 👍
Thanks. I might open another PR for changing those file names.
I tried to make some details in the documentation more explicit.