Skip to content

[doc] fix flight recorder tutorial #3189

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 1 commit into from
Dec 17, 2024
Merged

[doc] fix flight recorder tutorial #3189

merged 1 commit into from
Dec 17, 2024

Conversation

c-p-i-o
Copy link
Contributor

@c-p-i-o c-p-i-o commented Dec 17, 2024

Summary:
The small example code isn't rendering on the page.

Remove caption string as this seems to be the problem.

Test Plan:
Tested locally and on sandbox.
Without the fix: note missing code after "Note".
Broken screenshot:
Screenshot 2024-12-17 at 2 43 06 PM
Broken link here:
https://pytorch.org/tutorials/prototype/flight_recorder_tutorial.html#an-end-to-end-example

After the fix:
Fixed screenshot:
Screenshot 2024-12-17 at 2 42 03 PM
Sandbox link here:
https://docs-preview.pytorch.org/pytorch/tutorials/3189/prototype/flight_recorder_tutorial.html#an-end-to-end-example

Description

Checklist

  • The issue that is being fixed is referred in the description (see above "Fixes #ISSUE_NUMBER")
  • 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.

Summary:
The small example code isn't rendering on the page.
Remove caption as this seems to be problematic.

Test Plan:
Test on sandbox.
Copy link

pytorch-bot bot commented Dec 17, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/tutorials/3189

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 9318898 with merge base b8acfc8 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@c-p-i-o c-p-i-o self-assigned this Dec 17, 2024
@c-p-i-o c-p-i-o requested a review from svekars December 17, 2024 22:44
@c-p-i-o c-p-i-o marked this pull request as ready for review December 17, 2024 22:44
@c-p-i-o c-p-i-o merged commit 7262c21 into main Dec 17, 2024
20 checks passed
@svekars svekars deleted the chirag/fix-fr_tutorial branch December 17, 2024 22:50
vmoens pushed a commit that referenced this pull request Dec 20, 2024
Summary:
The small example code isn't rendering on the page.
Remove caption as this seems to be problematic.

Test Plan:
Test on sandbox.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants