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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option buildtest --helpcolor to show available color options in table format #1277

Merged
merged 6 commits into from
Oct 19, 2022

Conversation

prathmesh4321
Copy link
Collaborator

No description provided.

@prathmesh4321 prathmesh4321 linked an issue Oct 14, 2022 that may be closed by this pull request
2 tasks
@codecov
Copy link

codecov bot commented Oct 14, 2022

Codecov Report

Base: 77.99% // Head: 81.28% // Increases project coverage by +3.28% 🎉

Coverage data is based on head (b1974d6) compared to base (a596e4b).
Patch coverage: 80.65% of modified lines in pull request are covered.

❗ Current head b1974d6 differs from pull request most recent head e84d5d3. Consider uploading reports for the commit e84d5d3 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##            devel    #1277      +/-   ##
==========================================
+ Coverage   77.99%   81.28%   +3.28%     
==========================================
  Files          54       55       +1     
  Lines        5935     5944       +9     
  Branches     1026     1071      +45     
==========================================
+ Hits         4629     4831     +202     
+ Misses       1305     1113     -192     
+ Partials        1        0       -1     
Impacted Files Coverage Δ
buildtest/cli/compilers.py 72.18% <72.73%> (+13.31%) ⬆️
buildtest/cli/__init__.py 91.64% <100.00%> (+0.03%) ⬆️
buildtest/cli/helpcolor.py 100.00% <100.00%> (ø)
buildtest/builders/base.py 69.96% <0.00%> (+1.55%) ⬆️
buildtest/cli/build.py 94.52% <0.00%> (+1.77%) ⬆️
buildtest/buildsystem/builders.py 78.31% <0.00%> (+1.81%) ⬆️
buildtest/executors/setup.py 90.82% <0.00%> (+1.93%) ⬆️
buildtest/builders/script.py 78.21% <0.00%> (+3.85%) ⬆️
buildtest/config.py 64.50% <0.00%> (+4.50%) ⬆️
buildtest/utils/timer.py 88.89% <0.00%> (+11.11%) ⬆️
... and 4 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@shahzebsiddiqui shahzebsiddiqui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last thing can you please add a section for documentation. Perhaps you can mention this in https://buildtest.readthedocs.io/en/devel/features.html

@prathmesh4321
Copy link
Collaborator Author

One last thing can you please add a section for documentation. Perhaps you can mention this in https://buildtest.readthedocs.io/en/devel/features.html

Done ! @shahzebsiddiqui

@shahzebsiddiqui
Copy link
Member

@prathmesh4321 question about the image you uploaded about the buildtest --helpcolor if we want to add the picture we should probably add the command prompt $ buildtest --helpcolor or we dont include the image or run the command. If we include the image then it becomes one extra step to update the image if the command option changes or the output behavior.

I was looking at the generated docs https://buildtest--1277.org.readthedocs.build/en/1277/features.html#listing-available-color-options-buildtest-helpcolor and it looks nice but i am thinking we shouldnt have this output. Let's follow up on slack and would like to get your opinion on the docs

@prathmesh4321
Copy link
Collaborator Author

@prathmesh4321 question about the image you uploaded about the buildtest --helpcolor if we want to add the picture we should probably add the command prompt $ buildtest --helpcolor or we dont include the image or run the command. If we include the image then it becomes one extra step to update the image if the command option changes or the output behavior.

I was looking at the generated docs https://buildtest--1277.org.readthedocs.build/en/1277/features.html#listing-available-color-options-buildtest-helpcolor and it looks nice but i am thinking we shouldnt have this output. Let's follow up on slack and would like to get your opinion on the docs

@shahzebsiddiqui I have added the command instead of the picture. Let me know if that looks right.

Copy link
Member

@shahzebsiddiqui shahzebsiddiqui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I rephrased one sentence but this looks good.

@shahzebsiddiqui shahzebsiddiqui merged commit 6939258 into devel Oct 19, 2022
@shahzebsiddiqui shahzebsiddiqui deleted the issue_1206 branch October 19, 2022 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE]: Add buildtest -helpcolor flag to
2 participants