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

Improve readibility of compare_to_baseline output message #2025

Closed
wants to merge 1 commit into from

Conversation

mgrange1998
Copy link
Contributor

Summary:
Integrating the following feedback into the construction of the compare_to_baseline output message

" I'm noticing this could be a bit easier to digest. Luckily we can use markdown formatting as follows:

  • add an asterisk before each item in comparison_list so that the user gets a bulleted list.
  • put metric name + percent improvement first, followed by arm names + absolute metric values, since the former tends to be what the user most cares about.
  • bolding the first part of each line item can help create visual anchors for the reader.
  • adding backticks can help users identify variable names/values. "

Differential Revision: D51632256

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Nov 29, 2023
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D51632256

mgrange1998 pushed a commit to mgrange1998/Ax that referenced this pull request Nov 29, 2023
)

Summary:

Integrating the following feedback into the construction of the compare_to_baseline output message

 " I'm noticing this could be a bit easier to digest. Luckily we can use markdown formatting as follows:
* add an asterisk before each item in comparison_list so that the user gets a bulleted list.
* put metric name + percent improvement first, followed by arm names + absolute metric values, since the former tends to be what the user most cares about.
* bolding the first part of each line item can help create visual anchors for the reader.
* adding backticks can help users identify variable names/values. "

Differential Revision: D51632256
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D51632256

@codecov-commenter
Copy link

codecov-commenter commented Nov 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (14a5615) 94.47% compared to head (df20c5d) 94.47%.

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2025   +/-   ##
=======================================
  Coverage   94.47%   94.47%           
=======================================
  Files         460      460           
  Lines       44335    44335           
=======================================
  Hits        41885    41885           
  Misses       2450     2450           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mgrange1998 pushed a commit to mgrange1998/Ax that referenced this pull request Nov 29, 2023
)

Summary:

Integrating the following feedback into the construction of the compare_to_baseline output message

 " I'm noticing this could be a bit easier to digest. Luckily we can use markdown formatting as follows:
* add an asterisk before each item in comparison_list so that the user gets a bulleted list.
* put metric name + percent improvement first, followed by arm names + absolute metric values, since the former tends to be what the user most cares about.
* bolding the first part of each line item can help create visual anchors for the reader.
* adding backticks can help users identify variable names/values. "

Reviewed By: bernardbeckerman, mpolson64

Differential Revision: D51632256
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D51632256

)

Summary:

Integrating the following feedback into the construction of the compare_to_baseline output message

 " I'm noticing this could be a bit easier to digest. Luckily we can use markdown formatting as follows:
* add an asterisk before each item in comparison_list so that the user gets a bulleted list.
* put metric name + percent improvement first, followed by arm names + absolute metric values, since the former tends to be what the user most cares about.
* bolding the first part of each line item can help create visual anchors for the reader.
* adding backticks can help users identify variable names/values. "

Reviewed By: bernardbeckerman, mpolson64

Differential Revision: D51632256
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D51632256

@facebook-github-bot
Copy link
Contributor

This pull request has been merged in ef948b3.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity. fb-exported Merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants