Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improve HexDocs readiness for the v0.1.0 public preview API.
This PR keeps the existing v0.1.0 release scope and package metadata intact, then strengthens the generated documentation for first-time Hex users:
LeanLspdocs around the narrow v0.1.0 runtime-preview API;LeanLsp.runtime_config/1as side-effect-free option normalization;LeanLsp.start_runtime/1as Docker-backed runtime startup with caller cleanup responsibility;LeanLsp.Runtimebehaviour docs, types, callback return shapes, and runtime side-effect expectations;LeanLsp.Runtime.Configfunctions;LeanLsp.Runtime.Docker.start_link/1,stop/1, andexec/3visible in ExDoc despite being behaviour implementations;docker execcommand execution, container cleanup, external Docker requirements, runtime options, mounts, env vars, and timeouts;Notes
mix docsalready completed without warnings before this change, but the generated docs showed two gaps:LeanLsp.Runtime.Configpublic functions rendered mostly as specs without explanatory docs.LeanLsp.Runtime.Dockercallback implementations were hidden from the module page because@implmarks callback implementations as undocumented unless@docis explicitly provided.This PR addresses both gaps without changing README content or the README
## Licensesection.Validation
Run from a branch that contains the latest
origin/main:Manual docs review checklist:
LeanLspexplains that v0.1.0 is a runtime-preview release, not a complete Lean LSP client.LeanLsp.Runtime.Confighas docs fordefault_runtime/0,default_docker_image/0,default_container_workspace_root/0,normalize/1, andto_runtime_options/1.LeanLsp.Runtime.Dockershowschild_spec/1,start_link/1,stop/1, andexec/3with side-effect and cleanup notes.