adding links to elaborative testing #155
Conversation
| @@ -229,6 +229,8 @@ the IEEE-754 specification. | |||
| // %result: [[6, 8], [10, 12]] | |||
| ``` | |||
|
|
|||
| [More Examples](https://github.com/sdasgup3/stablehlo/blob/main/stablehlo/tests/interpret_add.mlir) | |||
|
|
|||
There was a problem hiding this comment.
Also what do you think about turning "Examples` into a link? We don't really need to keep examples in the markdown file once we have exhaustive tests, right?
There was a problem hiding this comment.
We already thought about this and here are our thoughts:
We want to keep a short example right in the spec to demonstrate, using a trivial (no corner cases) example, the functioning of the op and ask the reader to follow the link for more detailed tests. I believe having that quick-example-view provides better experience. Having said that, I agree that the example section of spec should be concise: One representative should be enough to capture the high level behavior unless the there are multiple behaviors like bitwise ops.
What do you think?
There was a problem hiding this comment.
" believe having that quick-example-view provides better experience". Sounds good, let's give this a try and see how it works out.
sdasgup3
force-pushed
the
issue-36
branch
4 times, most recently
from
4ebeaa9 to
0c4f0ec
Compare
| @@ -229,6 +229,8 @@ the IEEE-754 specification. | |||
| // %result: [[6, 8], [10, 12]] | |||
| ``` | |||
|
|
|||
| [More Examples](https://github.com/sdasgup3/stablehlo/blob/main/stablehlo/tests/interpret_add.mlir) | |||
|
|
|||
There was a problem hiding this comment.
" believe having that quick-example-view provides better experience". Sounds good, let's give this a try and see how it works out.
Adding hyperlinks in spec to test-files having elaborative tests.
Adding hyperlinks in spec to test-files having elaborative tests.
fixes #36
The indent is to differentiate the added link to the following "Back to Ops" link.