Value doc #625
Draft
Value doc #625
+269
−87
Conversation
This file contains 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
|
I am also in favor or just returning the content without Rendering it. Maybe as a function on the C-abi. |
inclyc
commented
Nov 23, 2024
| @@ -70,4 +70,10 @@ selectStringViews(nix::EvalState &State, nix::Value &V, | |||
| return selectSymbols(State, V, toSymbols(State.symbols, AttrPath)); | |||
| } | |||
|
|
|||
| /// TODO: use https://github.com/NixOS/nix/pull/11914 on nix version bump | |||
| /// \brief Get nix's `builtins` constant | |||
| inline nix::Value &getBuiltins(const nix::EvalState &State) { | |||
There was a problem hiding this comment.
maybe remove, not used in this PR
| @@ -31,6 +32,7 @@ constexpr inline std::string_view AttrPathInfo = "attrset/attrpathInfo"; | |||
| constexpr inline std::string_view AttrPathComplete = "attrset/attrpathComplete"; | |||
| constexpr inline std::string_view OptionInfo = "attrset/optionInfo"; | |||
| constexpr inline std::string_view OptionComplete = "attrset/optionComplete"; | |||
|
|
|||
|
|
||
| std::optional<ValueDescription> describeValue(nix::EvalState &State, | ||
| nix::Value &V) { | ||
| const auto Doc = State.getDoc(V); |
There was a problem hiding this comment.
nix::EvalState::getDoc() is invoked here
| @@ -87,6 +87,10 @@ class NixpkgsHoverProvider { | |||
| return OS.str(); | |||
| } | |||
|
|
|||
| static std::string mkValueMarkdown(const ValueDescription &ValueDesc) { | |||
| return ValueDesc.Doc; | |||
There was a problem hiding this comment.
here, the documentation is replied directly without any formatting/tokenization.
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.
This PR introduces
nix-repl's:doccommand to nixd.Since NixOS/nix#11072, we can utilize the API exposed by
nix::EvalState::getDoc. (i.e. to provide hover/completions(todo) from nixpkgs's doc comments).Current status:
:doccommand innix-replAlso CC @roberth (author of nix implementation), @hsjobeki (author of doc-comments RFC). How can we co-operate to make these stuff more fancy? (It looks very ugly so far, 😆 )
I see there are some information for "definition" here, generally this information is separated from "hover-ed documentation" in LSP, can we have a new API to get a structured output?