How to debug - An error occurred while building gem documentation

[mioruggieroguida]

When i rebuild the gems documentation, i keep getting this message.

An error occurred while building gem documentation

Is there a log where I can get more info?

this is my .solargraph.yml

---
include:
  - "**/*.rb"
exclude:
  - spec/**/*
  - vendor/**/*
  - ".bundle/**/*"
require:
 - openstudio-standards
domains: []
reporters:
  - rubocop
  - require_not_found
formatter:
  rubocop:
    cops: safe
    except: []
    only: []
    extra_args: []
require_paths: ["."]
plugins: []
max_files: 5000

[castwide]

Try running yard gems --verbose to see if you can determine which gem caused the error.

[mioruggieroguida]

Lots of warnings, but it completes. They look like this

[warn]: @param tag has unknown parameter name: model 
    in file `lib/openstudio-standards/btap/btap.model.rb' near line 651
[warn]: @param tag has unknown parameter name: model 
    in file `lib/openstudio-standards/btap/btap.model.rb' near line 659

[castwide]

Those are normal. They just warn that some YARD tags in the code are invalid, but the doc generation should still succeed.

When you get the error in VS Code, you could also check for debug output in the console (Help -> Toggle Developer Tools).

[mioruggieroguida]

this is the output from the console

notificationsAlerts.ts:42 An error occurred while building gem documentation.
c @ notificationsAlerts.ts:42
(anonymous) @ notificationsAlerts.ts:28
y @ event.ts:1127
z @ event.ts:1138
fire @ event.ts:1162
addNotification @ notifications.ts:228
notify @ notificationService.ts:253
(anonymous) @ mainThreadMessageService.ts:86
f @ mainThreadMessageService.ts:51
$showMessage @ mainThreadMessageService.ts:45
S @ rpcProtocol.ts:458
Q @ rpcProtocol.ts:443
M @ rpcProtocol.ts:373
L @ rpcProtocol.ts:299
(anonymous) @ rpcProtocol.ts:161
y @ event.ts:1127
fire @ event.ts:1158
fire @ ipc.net.ts:650
V.onmessage @ localProcessExtensionHost.ts:376
event.ts:42 [Violation] Added non-passive event listener to a scroll-blocking 'touchstart' event. Consider marking event handler as 'passive' to make the page more responsive. See https://www.chromestatus.com/feature/5745543795965952
onWillAddFirstListener @ event.ts:42
q @ event.ts:1045
(anonymous) @ event.ts:118
onWillAddFirstListener @ event.ts:193
q @ event.ts:1045
U @ listWidget.ts:685
D @ listWidget.ts:1521
ce @ listWidget.ts:1501
K @ listService.ts:288
j @ instantiationService.ts:119
createInstance @ instantiationService.ts:85
r @ notificationsList.ts:74
show @ notificationsList.ts:53
Q @ notificationsToasts.ts:213
(anonymous) @ notificationsToasts.ts:160
execute @ dom.ts:325
Dt @ dom.ts:366
(anonymous) @ dom.ts:384

Does it help?

[castwide]

It looks like the error might be occurring in the VS Code extension itself instead of the language server. I just ran a couple tests and was able to reproduce the error locally, so I'll look into it further.