Enforce that every toplevel field of organist has some documentation
#211
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
added 7 commits
June 19, 2024 13:28
Makes it clear what Nix has (or not) access to. Also makes it possible in the future to fearlessly use enums in the config, as they won't be exported
Removes the need from running `regenerate-files` manually
This is in particular useful when the source file is generated with Nix.
Use for instance with:
```nickel
{
files."foo".file = nix.import_nix "nixpkgs#foo",
}
```
Avoids the need for an explicit `nix run .#regenerate-lockfile`
Ensure that autocompletion works fine for simple things
We can't really check the quality of the documentation (fortunately for me), but at least ensure that there's _some_ documentation for the most common things
thufschmitt
force-pushed
the
test-the-lsp
branch
2 times, most recently
from
86b627b to
bcb0811
Compare
thufschmitt
force-pushed
the
transparent-regen
branch
3 times, most recently
from
2520576 to
436e249
Compare
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.
We can't really check the quality of the documentation (fortunately for me), but at least ensure that there's some documentation for the most common things