@enum and @alias comments rendered as markdown#3258
@enum and @alias comments rendered as markdown#3258tommaisey wants to merge 5 commits intoLuaLS:masterfrom
Conversation
|
Hi tommaisey! Could you provide some before/after pics? |
tommaisey
force-pushed
the
render-alias-enum-markdown
branch
2 times, most recently
from
2078687 to
8d12152
Compare
|
@C3pa Sorry for the long delay. I've been very busy at work. I rebased the branch. Here are some screenshots. Before: After: |
No big deal! This is only a hobby! May I say this looks very good Tommaisey! There is only one minor nitpick: the description comment is now duplicated: 
Can it be removed? |
tommaisey
force-pushed
the
render-alias-enum-markdown
branch
from
fb231b6 to
01c48a0
Compare
|
@C3pa Good suggestion, I managed to do that. I also cleaned up a little code in a 
|
| local orders = {'function', 'doc.type.function'} | ||
| table.sort(defs, function (a, b) | ||
| return orders[a] < orders[b] | ||
| return (orders[a.type] or (#orders + 1)) < (orders[b.type] or (#orders + 1)) |
There was a problem hiding this comment.
This repeatedly calls #orders for defs with a type that's not in the orders array. Obviously, I don't have any benchmarking data here, but you could cache the orders size outside the callback function.
|
Thanks for changing the description format! Looks good. |
2 participants
At present these are rendered as blocks of code. This isn't ideal - most of the other documentation/hovers are rendered as formatted markdown. Now these are too, and I think this looks better.