Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fsdocs --eval not functioning in DiffSharp after recent update #662

Closed
dsyme opened this issue Apr 13, 2021 · 1 comment · Fixed by #663
Closed

fsdocs --eval not functioning in DiffSharp after recent update #662

dsyme opened this issue Apr 13, 2021 · 1 comment · Fixed by #663

Comments

@dsyme
Copy link
Contributor

dsyme commented Apr 13, 2021

See DiffSharp/DiffSharp#317 (comment)

@gbaydin There is some weird issue with evaluating scripts during documentation generation - the FSharp.Compiler.Service evaluation code underlying fsdocs --eval is not resolving overloaded methods correctly when used with DiffSharp

Basic script evaluation in fsdocs is working - there are many tests in the fsdocs repo. So this must have something to do with specifics when applied in the DiffSharp repo - e.g. mismatched FSharp.Core versions (though the tools are the same), or mismatched .NET Core versions (though fsdocs is running in .NET 5.0), or something else like this.

Unfortunately it doesn't repro locally for me on Windows so it's hard for me to debug.

We aren't actually currently relying on script evaluation during documentation generation in DiffSharp, so I recommend we actually just turn off --eval for now. It is more important to update the documentation tool and author the documentation - we can track this down later.

The repro is to turn on --eval in the DiffSharp repo (the linked pull request removes it)

@dsyme
Copy link
Contributor Author

dsyme commented Apr 13, 2021

OK I think I may know the cause of this error

Recent changes switched to doing API doc generation first (part of a change so that content can reference into the API docs). API doc generation was needlessly installing an assembly resolve handler which was causing false assembly loads, interfering with script evaluation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant