Skip to content

Remove Markdown backticks, use RST syntax for code block #3381

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

Merged
merged 7 commits into from
Jun 5, 2025

Conversation

Rachel0619
Copy link
Contributor

@Rachel0619 Rachel0619 commented Jun 4, 2025

Fixes #2814

Description

Replaced Markdown backticks (```) with proper reStructuredText syntax (::) in the introyt1 tutorial code block to fix documentation rendering.

Checklist

  • The issue that is being fixed is referred in the description (see above "Fixes Minor style bug: remove backticks in the section of code #2814")
  • Only one issue is addressed in this pull request
  • Labels from the issue that this PR is fixing are added to this pull request
  • No unnecessary issues are included into this pull request.

cc @svekars @sekyondaMeta @AlannaBurke

Copy link

pytorch-bot bot commented Jun 4, 2025

🔗 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 SEVs

There 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.

@facebook-github-bot
Copy link
Contributor

Hi @Rachel0619!

Thank you for your pull request and welcome to our community.

Action Required

In 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.

Process

In 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 CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@github-actions github-actions bot added docathon-h1-2025 A label for the docathon in H1 2025 easy website Issues related to website rendering labels Jun 4, 2025
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot
Copy link
Contributor

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:
# ```
# ::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

totally agree -> we should indent to the left for proper rendering

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank y'all for the review! I've fixed the spacing issue.

@AlannaBurke
Copy link
Contributor

Link to preview while i've got it handy: https://docs-preview.pytorch.org/pytorch/tutorials/3381/beginner/introyt/introyt1_tutorial.html

@AlannaBurke
Copy link
Contributor

Monosnap Introduction to PyTorch — PyTorch Tutorials 2 7 0+cu126 documentation 2025-06-04 21-36-27

still seeing a formatting issue here

@Rachel0619
Copy link
Contributor Author

image Thank you for bearing with the back and forth. I think it works now with my latest commit!

@svekars svekars merged commit 640fd89 into pytorch:main Jun 5, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla signed docathon-h1-2025 A label for the docathon in H1 2025 easy website Issues related to website rendering
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Minor style bug: remove backticks in the section of code
4 participants