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

Commits on Nov 29, 2023

  1. Improve readibility of compare_to_baseline output message (facebook#2025

    )
    
    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
    Matthew Grange authored and facebook-github-bot committed Nov 29, 2023
    Configuration menu
    Copy the full SHA
    a345835 View commit details
    Browse the repository at this point in the history