Missing documentation for b:coc_diagnostic_info.lnums.

[adriantrunzo]

Hi all,

The documentation for the b:coc_diagnostic_info variable doesn't include the lnums property. That property seems great for showing the line number of the first error or warning in the statusline, but I don't want to rely on it if it is not officially supported.

When I trigger a warning, for example, this is the output I see for echo b:coc_diagnostic_info:

{'information': 0, 'hint': 0, 'lnums': [0, 21, 0, 0], 'warning': 1, 'error': 0}  

And indeed the warning is on line 21. If I trigger an error, I see the following:

'information': 1, 'hint': 0, 'lnums': [12, 0, 12, 0], 'warning': 0, 'error': 1}

From experimentation it seems that the lnums positions are as follows:

0: error line number
1: warning line number
2: information line number
3: hint line number

I've tried searching the source code for the definition of lnums but I couldn't find it. Can someone please point out the relevant source code to me? I'd like to learn why I cannot find it.

Will the lnums property be added to the documentation? Or is it an internal property that should not be used?

Thanks for the help!

[fannheyward]

Hello, the coc_diagnostic_info is defined in

coc.nvim/src/diagnostic/buffer.ts

Lines 187 to 208 in 9be0d9e

	let lnums = [0, 0, 0, 0]
	let info = { error: 0, warning: 0, information: 0, hint: 0, lnums }
	for (let diagnostic of diagnostics) {
	switch (diagnostic.severity) {
	case DiagnosticSeverity.Warning:
	info.warning = info.warning + 1
	lnums[1] = lnums[1] || diagnostic.range.start.line + 1
	break
	case DiagnosticSeverity.Information:
	info.information = info.information + 1
	lnums[2] = lnums[2] || diagnostic.range.start.line + 1
	break
	case DiagnosticSeverity.Hint:
	info.hint = info.hint + 1
	lnums[3] = lnums[3] || diagnostic.range.start.line + 1
	break
	default:
	lnums[0] = lnums[0] || diagnostic.range.start.line + 1
	info.error = info.error + 1
	}
	}
	this.nvim.call('coc#util#set_buf_var', [this.bufnr, 'coc_diagnostic_info', info], true)

the lnums is line number of the diagnostic.

lnums = [0, 0, 0, 0] => [error, warning, info, hint], your understanding is correct.

[adriantrunzo]

Hi,

Thanks for the response @fannheyward! I realize now that the /src directory is not on the release (default) branch, which is why I could not find this code. Much appreciated!

I'd be happy to open a PR with an update to the documentation, if that is helpful.