-
-
Notifications
You must be signed in to change notification settings - Fork 548
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: list-task with multiline desc #1656
base: main
Are you sure you want to change the base?
Conversation
Also related: I generally agree that descriptions should be short and kept to a single line. However, I suspect we will have users complain about options 1 and 2 as it restricts their options. A lot of people use the I've had a ton of issues using |
@pd93 I agree, I was not aware of this issue. I've changed to the solution 3. I've also fixed the issue with experiments display. Now, all experiments are aligned in a table. It seems tabwrite does not work well with colors (cf : https://stackoverflow.com/questions/35398497/how-do-i-get-colors-to-work-with-golang-tabwriter / fatih/color#175 / golang/go#12073) That why, it can be trick, as we display multiple colors in the same table. It may be worthy to take a look at https://github.com/juju/ansiterm/ |
I've push a last version, using https://github.com/Ladicle/tabwriter as a drop in replacement of tabwriter but supporting color It's way easier to use (no more headache debugging the tabwrite, yes I have a headache now 😂 ) than the text/tabwriter I've separate in multiple commit, so we can revert a part if needed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I prefer option 1, forcing descriptions to be a single line. We have summary
for longer documentation.
Thoughts?
Co-authored-by: Andrey Nering <andrey@nering.com.br>
I totally agree with you @andreynering. I did this at the first time before the @pd93's comment |
Linked to :
I have multiple solutions in mind
First solution : remove all \n so we display one line
Second solution : Display only the first line. We could considere for longer desc, we should use summary and not desc
Third solution: Display "as it" with multiline
I would considere that desc should be short and summary for long description. So, I would go for the first one.