I’m using the prolog lsp server by @jamesnvc , and I find it works perfectly for going to definition, references, and quickly seeing documentation of builtin predicates. However, I can’t get it to display the documentation for my own predicates. Perusing the source of the lsp_server, I think they sho…

[image] peter.ludemann: with the removal of private(Full,Options) from packages/pldoc/doc_man.pl Amazing, is that something that could be done on the user side as an option, or does it require editing the source files?

[image] meditans: is that something that could be done on the user side as an option, or does it require editing the source files? I edited the source files (I routinely build and install from the github sources). If you install in a user-writeable director, you can edit the source files. Fo…

Back to the original, the file defines bar/2, but documents bar/1. You easily see this when using swipl --pldoc foo.pl For me, as is, help(bar) results in telling me there is no help for bar and showing the close match var/1 as alternative. After fixing the comment it works as expected. Does …

[image] jan: Does anyone has a reproducible example of main_page//2 failing when called from help/1 ? This is my test file (it’s longer than it needs to be). It succeeds with the exported predicate and fails with the non-exported one. (I earlier reported that it failed with an exported predica…

Thanks. No time now, but I should investigate this. Just removing might give undesirable side effects.

Pushed a fix that Preserves the module for user defined predicates, so we do mix up different predicates Show matches, also when private by passing an extra option and checking this when deciding to hide some predicate or not. Probably a step in the right direction, but whether it always does wha…

[image] jan: Pushed a fix I did a quick test … one thing I noticed is that when I simply removed the \+private(...) test, the output from help(transform_kythe_fact) was transform_kythe_fact(+Fact0, -Fact1) is det[private] ... other comments ... but with the change a608a5a87f0f90f185184…

[image] jan: Pushed a fix that Preserves the module for user defined predicates, so we do mix up different predicates Show matches, also when private by passing an extra option and checking this when deciding to hide some predicate or not. Thanks Jan, also tested the problem reported in Tex…

[image] peter.ludemann: is det[private] Pushed a little more elegant solution that preserves this annotation.

[image] jan: Pushed a little more elegant solution that preserves this annotation. Tested on my complete source, and seems good. If my source has set_prolog_flag(autoload,false), and I turn autoload on after loading it (and warn_autoload is also set), I get this: ?- set_prolog_flag(autoload…

Documentation of user-defined predicates in the prolog lsp-server

General

swi October 18, 2023, 6:33pm 21

Thanks Jan, also tested the problem reported in Text help fails in some cases, and it is solved.

Topic		Replies	Views
Programmatic interface to library(help)? General	3	101	July 17, 2025
Autoload and qsave (swipl -c) don't go together Tools	27	1820	February 12, 2020
Properties of modules and predicates Wiki how-to	0	789	July 4, 2020
ChatGPT prompts - SWI-Prolog (2) Wiki chatgpt	0	781	February 17, 2023
Changing autoload Request For Comments	15	1210	February 12, 2020

Documentation of user-defined predicates in the prolog lsp-server

Related topics