Add shortDescription to appsSchema#31
Open
shivaraj-bh wants to merge 1 commit intoDeterminateSystems:mainfrom
Open
Add shortDescription to appsSchema#31shivaraj-bh wants to merge 1 commit intoDeterminateSystems:mainfrom
shortDescription to appsSchema#31shivaraj-bh wants to merge 1 commit intoDeterminateSystems:mainfrom
Conversation
Author
|
|
srid
reviewed
Aug 31, 2024
| && app ? program | ||
| && builtins.isString app.program; | ||
| what = "app"; | ||
| shortDescription = app.description or ""; |
Contributor
There was a problem hiding this comment.
Per NixOS/nix#11297, this should be app.meta.description, right?
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.
Flake
appscould benefit from a description. As an example, here’s a simple flake:and the corresponding
nix flake show --default-flake-schemas github:shivaraj-bh/flake-schemas/apps --jsonoutput, wherenixis compiled from https://github.com/DeterminateSystems/nix-src/tree/flake-schemas:{ "apps": { "doc": "The `apps` output provides commands available via `nix run`.\n", "output": { "children": { "aarch64-darwin": { "children": { "hello": { "leaf": true, "shortDescription": "I say hello!", "what": "app" } } } } } }, ... }Question
Should we stick to the
metaattribute of derivations forappsas well?