Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(description): Add description option for tasks #831

Conversation

SheldonNunes
Copy link

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?

  • Creates a new method description in the task.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?

  • It is possible that consumers may already have a property called description that could cause unexpected effects. Potential mitigation would be to rename to task_description which would have lower chance of collision.

Questions

  • Would reviewers prefer if this change did not impact the template?
  • If we keep the template change should I update the README examples or keep them as is (description doesn't provide too much value for readers)?

馃帺 馃帺 馃帺 馃帺 馃帺

image image image

@SheldonNunes SheldonNunes force-pushed the SheldonNunes/add_description_to_tasks branch from 4e691ae to 86331c6 Compare May 31, 2023 20:29
@SheldonNunes SheldonNunes force-pushed the SheldonNunes/add_description_to_tasks branch from 86331c6 to 3a47630 Compare May 31, 2023 21:15
@velimovich
Copy link

Hey folks!
This is an amazing change, would love to have it in our project as soon as possible! Is there any chance that it will be included in one of next releases?

@etiennebarrie
Copy link
Member

As explained in #889 he gem is really meant for data migrations, aimed at developers, and we don't think we need to add more logic to show data that can be added as a comment in the code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants