diff --git a/docgen/docgen.lua b/docgen/docgen.lua index 0e4f9d13d..3701a9a80 100644 --- a/docgen/docgen.lua +++ b/docgen/docgen.lua @@ -595,17 +595,15 @@ docgen.render = function(configuration_option, open) "* " or ">"), "", ((self.data.name or ""):match("^%s*$") and "" or table.concat({ - "", + "
", self.data.name, - "", + "
", })) .. " (" .. type_of_object .. ")
", "", } if not vim.tbl_isempty(self.comments) then vim.list_extend(basis, { - "
", - "", "
", "", }) @@ -615,8 +613,6 @@ docgen.render = function(configuration_option, open) "", "
", "", - "
", - "", }) else vim.list_extend(basis, { diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index a1539e2a3..a61d12246 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -11,6 +11,7 @@ Whilst any help is very special, please be considerate of certain rules in order - [Formatting rules](#formatting-rules) - [Coding style](#coding-style) - [Adding extra functionality](#adding-functionality) + - [Helping with documentation](#helping-with-documentation) --- ### Reporting a bug or issue @@ -36,7 +37,7 @@ You can then run `make format` in the project root to automatically format all y ### Coding style - I use snake_case for everything, and you should too :P -- **Please** comment all your code! Documentation for functions is generated by [neogen](https://github.com/danymat/neogen). +- **Please** comment all your code! Annotations for functions are generated by [neogen](https://github.com/danymat/neogen).