feat: only add description subject to table #198
Merged
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.
Instead of adding the whole description to the table (inputs and outputs) only the first line should be added.
Similar to best practice of git commit messages the description would benefit if the description will be split to subject and body.
In the first line the basic information will be placed (subject).
Followed after a blank line the body will follow.
The full description (subject and body) will then be available in the usage section only.
This will improve the readability of the table.
Example
Usage
Inputs
multiline-with-space
action.yml
singleline
action.yml
multiline-without-space
but no space after ln
action.yml
Diff
Inputs