Skip to content

Support for docstrings in .d.tl files #52

@makspll

Description

@makspll

The extension could interpret and show docstrings above records like this one when hovering over terms:

local record global_types
--This is module level documentation for our api, it will be shown first
--
--
--
	record APIModule
		userdata

		-- Pure functions
		--Here we document the next function
		--
		--## Markdown!:
		--
		--```lua
		--                local hello = "string"  
		--            
		--```
		my_function: function(string):(string)

		help: function(string):(string)


	end
end

global my_api: global_types.APIModule
return global_types

This would be especially useful for projects like tealr.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions