Improve action input descriptions and reorder consistently#1074
Merged
Improve action input descriptions and reorder consistently#1074
Conversation
The input descriptions in action.yml were minimal and inconsistent — some (windows-environment, windows-compiler) had detailed multi-line descriptions whilst others had only a single terse sentence. This enriches all descriptions with practical details (accepted values, default behaviour, related inputs) and reorders inputs consistently across action.yml, README.md, and constants.ts by user relevance: core settings first, then opam, caching, Windows, and advanced.
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
action.ymlwith practical details — accepted values, default behaviour, related inputs, and platform-specific notes — to match the level of detail already present inwindows-environmentandwindows-compiler.action.yml,README.md, andconstants.tsby user relevance: core settings first, then opam behaviour, caching, Windows-specific, and advanced/internal.cache-prefixwas listed asv1but is actuallyv3).Test plan