[Tutorial] Fix formatting, grammar, dead link#9281
Conversation
|
Thank you for catching these. I would like to request a change in how the links are handled. Instead of direct links, can we please use Sphinx reference links? This will help prevent breaks in the future. For example, this file has a reference at the top of it: We can write the link to that as: This will make the link more durable and less likely to break if the files are ever moved again. There is documentation for Sphinx that describes this feature more fully. This would be a great start on that. Thank you for sending up this patch, and catching links that I missed in the refactor. |
|
One more comment, if the target link doesn't have a reference tag as shown above, it should be added. Any name that doesn't collide with another tag should work. If you need me to build the docs and check once the patch is up, I'd be happy to help out with that. |
|
Agree that it would be best to make the change @hogepodge suggested to avoid future breakage. Thanks for the fix! |
|
I pushed three more commits, the last of which adopts sphinx references. @hogepodge, it would be great if you could build and check if it works. |
8ea34bc to
40d19b9
Compare
|
I also noticed one code block1 that looks like having the comments not be outside the block might not be intentional. Footnotes |
40d19b9 to
2e749bd
Compare
|
I added another commit, fixing a link in |
|
@mkroening I did a pass through the code and fixed a bunch of other links. Rather than send competing patching, can you check the differences in this patch and update to catch the remainder of direct links? |
|
Probably easier to compare from this PR: #9314 |
492268a to
d26ed50
Compare
|
@hogepodge, I subtracted #9314 from this PR. |
d26ed50 to
1f57f0d
Compare
|
I think the CI failure should be unrelated to this PR. |
|
If you push a basic change it will re-kick the gate job. I’m sorry this is taking so long to merge. |
1f57f0d to
c1ca1d4
Compare
|
Another spurious error, trying again. |
95bb1cb to
75b0a24
Compare
This fixes the indentation of metadata in `preprocess.py` in the TVMC tutorial, removing the leading whitespaces in the HTML rendering[^1]. [^1] https://tvm.apache.org/docs/tutorial/tvmc_command_line_driver.html#preprocess-py
75b0a24 to
a4a1643
Compare
|
Okay, on the sixth try CI passes. 🎉 |
|
🎉 |
* tutorial: preprocess.py: Fix leading whitespace This fixes the indentation of metadata in `preprocess.py` in the TVMC tutorial, removing the leading whitespaces in the HTML rendering[^1]. [^1] https://tvm.apache.org/docs/tutorial/tvmc_command_line_driver.html#preprocess-py * tutorial: Add missing code block escapes * tutorial: Grammar fixup * README.md: Fix link to introduction Co-authored-by: Martin Kröning <martin.kroening@neclab.eu>
* tutorial: preprocess.py: Fix leading whitespace This fixes the indentation of metadata in `preprocess.py` in the TVMC tutorial, removing the leading whitespaces in the HTML rendering[^1]. [^1] https://tvm.apache.org/docs/tutorial/tvmc_command_line_driver.html#preprocess-py * tutorial: Add missing code block escapes * tutorial: Grammar fixup * README.md: Fix link to introduction Co-authored-by: Martin Kröning <martin.kroening@neclab.eu>
This fixes a few issues (formatting, dead links, grammar), I encountered when reading the tutorial.
@hogepodge, could you review this?