Remove Markdown backticks, use RST syntax for code block #3381
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3381
Note: Links to docs will display an error until the docs builds have been completed. ❗ 1 Active SEVsThere are 1 currently active SEVs. If your PR is affected, please view them below: This comment was automatically generated by Dr. CI and updates every 15 minutes. |
|
Hi @Rachel0619! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
github-actions
bot
added
docathon-h1-2025
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
| @@ -304,7 +304,8 @@ def num_flat_features(self, x): | |||
| # standard deviations (second tuple) of the rgb values of the images in | |||
| # the dataset. You can calculate these values yourself by running these | |||
| # few lines of code: | |||
| # ``` | |||
| # :: | |||
There was a problem hiding this comment.
This looks good but I would remove the extra spaces that are causing it to indent the code block, it makes it harder to read when the block isn't as wide.
There was a problem hiding this comment.
totally agree -> we should indent to the left for proper rendering
There was a problem hiding this comment.
Thank y'all for the review! I've fixed the spacing issue.
|
Link to preview while i've got it handy: https://docs-preview.pytorch.org/pytorch/tutorials/3381/beginner/introyt/introyt1_tutorial.html |
|
still seeing a formatting issue here |
Thank you for bearing with the back and forth. I think it works now with my latest commit!
|
Fixes #2814
Description
Replaced Markdown backticks (```) with proper reStructuredText syntax (::) in the introyt1 tutorial code block to fix documentation rendering.
Checklist
cc @svekars @sekyondaMeta @AlannaBurke