Add example output after the code examples #82
Conversation
|
|
| code_node = node.replace(code) | ||
| # If the example has HHVM output associated with it, then print it | ||
| # after the code example | ||
| if File.exists? (full_path + ".example.hhvm.out") |
There was a problem hiding this comment.
Do you want to include .expect too (but not .expectf etc)?
There was a problem hiding this comment.
Right now, I always expect a .example.hhvm.out for output.
I instruct example creators to directly copy the .expect file as an .example.hhvm.out;
if there is an .expectf, then I should write that you run the the test with no-clean and copy the resulting .out file into .example.hhvm.out.
We could check for .hhvm.expect to optionally avoid the copy. Check for .example.hhvm.out, if doesn't exist, then check for .hhvm.expect.
There was a problem hiding this comment.
Yeah, avoiding the copy would be nice. It would also be good if we could check that the .example.hhvm.out match the expectf/expectre
There was a problem hiding this comment.
It would also be good if we could check that the .example.hhvm.out match the expectf/expectre
By running the test runner in process here for that particular example? Or some sort of regex check? All of our examples should pass the test runner. So if you produce the .example.hhvm.out via a run of the test runner, they would have to match because the test pass.
|
Maybe I don't understand git well enough :/ I just updated the pull request and pushed the changes. My changes are in a70ddfb, but why do I see those other two commits from @fredemmott there? Are we in sync? Or do I need to do something else? |
|
Heck, I think I know why. I probably rebased against master instead of this branch and pull in the latest commits from master. Ugh. Ok. I will try to fix. |
JoelMarcey
force-pushed
the
add-example-output
branch
from
4d42ab8 to
957cdb1
Compare
|
OK. I think we are settled now. Interactive rebase and force push. |
| output = doc.document.create_element( | ||
| 'pre', | ||
| File.read(output_path), | ||
| language: 'Bash', |
There was a problem hiding this comment.
Oh wait - I did do that on purpose actually.
This is output like you would see at the shell, from the command line. That's why I chose Bash.
There was a problem hiding this comment.
I can change it to "text". That's fine too, I guess.
There was a problem hiding this comment.
I think bash gives you shell-script highlighting - i.e. it's for files that start with #!/bin/sh or #!/bin/bash
No need to duplicate the two files for output. Just use the `.hhvm.expect` file. See: #82 I will update the CONTRIBUTING.md documentation to reflect this.
|
I committed 49718bf in preparation for this. So the only .example.hhvm.out files that exist now are the ones where we have a But for now we have manually added them in the interim. Any way to merge this before the push today? |
We are going to be automatically adding output files via #82
Add example output after the code examples
Fixes #47