feat(description): Add description option for tasks #831
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.
What does this PR do and why is it necessary?
This PR adds the feature support to add descriptions to tasks. This is useful as it brings any comment/description from the source code into the UI itself and can be helpful for those who aren't developers.
How does this PR work?
description
in thetask.rb
file. This is based off of a similar method in graphql-ruby that provides similar accessor functionality of setting the description.What could go wrong?
description
that could cause unexpected effects. Potential mitigation would be to rename totask_description
which would have lower chance of collision.Questions
README
examples or keep them as is (description doesn't provide too much value for readers)?馃帺 馃帺 馃帺 馃帺 馃帺