Skip to content
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

Fix docs formatting #1412

Merged
merged 2 commits into from
Dec 21, 2024
Merged

Fix docs formatting #1412

merged 2 commits into from
Dec 21, 2024

Conversation

divyanshk
Copy link
Contributor

Fixes #1410

Confirmed by running docs on local machine there bullets work fine, and Returns format correctly.
Screenshot 2024-12-20 at 12 20 46 PM
Screenshot 2024-12-20 at 12 29 42 PM

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Dec 20, 2024
Copy link

pytorch-bot bot commented Dec 20, 2024

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/data/1412

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

✅ No Failures

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

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

Copy link
Contributor

@andrewkho andrewkho left a comment

Choose a reason for hiding this comment

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

LGTM, although I think this works too and might be more consistent with the way Args are defined

Args:
  x
  y
  z

Returns:
  bool - blah blah blah

@divyanshk
Copy link
Contributor Author

Yup, now args and returns are formatted the same way.

@divyanshk divyanshk merged commit 62092dd into main Dec 21, 2024
39 checks passed
@divyanshk divyanshk deleted the divyanshk/docs-formatting branch December 21, 2024 05:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix formatting on pytorch docs
3 participants