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

x/perf/cmd/benchstat: GitHub markdown table output #34482

Open
mdempsky opened this issue Sep 23, 2019 · 4 comments
Open

x/perf/cmd/benchstat: GitHub markdown table output #34482

mdempsky opened this issue Sep 23, 2019 · 4 comments

Comments

@mdempsky
Copy link
Member

@mdempsky mdempsky commented Sep 23, 2019

GitHub supports tables in markdown format: https://help.github.com/en/articles/organizing-information-with-tables

It would be handy if benchstat could easily output in this format for pasting benchstat output into issues.

@ashley
Copy link

@ashley ashley commented Oct 26, 2019

Is this issue taken? If not, I would like to work on this.

@mdempsky
Copy link
Member Author

@mdempsky mdempsky commented Oct 26, 2019

@ashley Okay by me, but I'm not in charge of benchstat.

Two caveats I realized after filing the feature request:

  1. GitHub doesn't handle wide tables very well, but maybe this was just because I had very long test names with a lot of measurements. At least worth playing around with.

  2. benchstat does have CSV output, so maybe a csv2markdown tool would be more generally useful (and maybe already exists)? I can see arguments either way.

@ashley
Copy link

@ashley ashley commented Oct 26, 2019

@mdempsky There's actually a work around for this. Benchstat has a -html flag, and you can use the <table>...</table> component in GitHub or any Markdown file. That being said, maybe @dmitris can help decide whether it is worth adding a markdown flag to benchstat.

@mdempsky
Copy link
Member Author

@mdempsky mdempsky commented Oct 26, 2019

Oh, I didn't know GitHub supported HTML tables too. Good to know.

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

Successfully merging a pull request may close this issue.

None yet
4 participants