Improves type annotations (#465)

* Improves type annotations of `Logbook`

* Improves `Section` type annotations

* Removes local variables that were not necessary

* Adds type for `node` in Logbook

Author: chuck-flowers

lua/orgmode/parser/logbook.lua

@@ -54,8 +54,8 @@ function Logbook:get_total_minutes(from, to)
   return total_minutes
 end
 
----@param from string
----@param to string
+---@param from? string
+---@param to? string
 ---@return Duration
 function Logbook:get_total(from, to)
   return Duration.from_minutes(self:get_total_minutes(from, to))
@@ -134,7 +134,8 @@ function Logbook:recalculate_estimate(line)
 end
 
 ---@param lines string
----@param dates string
+---@param node userdata
+---@param dates Date[]
 ---@return Logbook
 function Logbook.parse(lines, node, dates)
   local opts = {
@@ -173,6 +174,10 @@ function Logbook.new_from_section(section)
   })
 end
 
+---@param lines any
+---@param node any
+---@param dates Date[]
+---@return table
 function Logbook._parse_clocks(lines, node, dates)
   local items = {}
   local range = Range.from_node(node)

lua/orgmode/parser/section.lua

@@ -11,7 +11,7 @@ local Logbook = require('orgmode.parser.logbook')
 local config = require('orgmode.config')
 
 ---@class Section
----@field id number
+---@field id string
 ---@field line_number number
 ---@field level number
 ---@field node table
@@ -20,7 +20,7 @@ local config = require('orgmode.config')
 ---@field line string
 ---@field range Range
 ---@field sections Section[]
----@field todo_keyword table<string, string>
+---@field todo_keyword SectionTodoKeyword
 ---@field priority string
 ---@field title string
 ---@field category string
@@ -34,8 +34,35 @@ local config = require('orgmode.config')
 ---@field clocked_in boolean
 local Section = {}
 
+---@class SectionTodoKeyword
+---@field node unknown
+---@field type 'TODO'|'DONE'|''
+---@field value string
+
+---@class NewSectionOptions
+---@field content string[]
+---@field dates Date[]
+---@field level number
+---@field line string
+---@field logbook Logbook
+---@field node table
+---@field own_tags string[]
+---@field parent Section
+---@field priority string
+---@field properties table
+---@field range Range
+---@field root File
+---@field tags string[]
+---@field title string
+---@field todo_keyword_node unknown
+
+---Constructs a new Section
+---@param data NewSectionOptions
+---@return Section
 function Section:new(data)
   data = data or {}
+
+  ---@type Section
   local section = {}
   section.id = string.format('%s####%s', data.root.filename or '', data.range.start_line)
   section.line_number = data.range.start_line
@@ -337,7 +364,7 @@ function Section:is_last_section()
   return self.parent.sections[#self.parent.sections].id == self.id
 end
 
----@return Section
+---@return Section?
 function Section:get_prev_headline_same_level()
   if self:is_first_section() then
     return nil
@@ -353,7 +380,7 @@ function Section:get_prev_headline_same_level()
   return nil
 end
 
----@return Section
+---@return Section?
 function Section:get_next_headline_same_level()
   if self:is_last_section() then
     return nil