Skip to content

Convert to markdown: cpp_extension.rst, cpp_index.rst, cpu.rst, cuda_environment_variables.rst, cuda._sanitizer.rst #155110

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Convert to markdown: cpp_extension.rst, cpp_index.rst, cpu.rst, cuda_environment_variables.rst, cuda._sanitizer.rst #155110

wants to merge 7 commits into from

Conversation

zeshengzong
Copy link
Contributor

@zeshengzong zeshengzong commented Jun 4, 2025 •
edited
Loading

@pytorch-bot PyTorch Bot
Copy link

pytorch-bot bot commented Jun 4, 2025 •
edited
Loading

🔗 Helpful Links

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

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

✅ No Failures

As of commit 0a519e5 with merge base 178515d (image):
💚 Looks good so far! There are no failures yet. 💚

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

@github-actions github-actions bot added docathon-h1-2025 medium Label for medium docathon tasks module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Jun 4, 2025
@sekyondaMeta sekyondaMeta added the topic: not user facing topic category label Jun 4, 2025
zxiiro
zxiiro previously approved these changes Jun 4, 2025
View reviewed changes
zxiiro
zxiiro reviewed Jun 4, 2025
View reviewed changes
svekars
svekars reviewed Jun 4, 2025
View reviewed changes
docs/source/cpp_index.md
@@ -0,0 +1,44 @@
# C++

Copy link
Contributor

@svekars svekars Jun 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

please use git mv to convert to .md instead of deleting the .rst file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually it's git mv and then update content, not sure why showing delete & add in here, let me find out. Thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Its due to how Git works internally. If too many lines in a file is changed Git won't find similarity between 2 files so doesn't show that they were renamed. Git doesn't actually store the history of changes in its database but rather the state of the entire workspace. I tried to explain it here hopefully it helps explain but this is expected.

#155120 (comment)

Copy link
Contributor Author

@zeshengzong zeshengzong Jun 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks you for help! Here's a similar explanation:

  • Git does not explicitly track moves/renames.
  • It detects them by comparing the content of deleted files with newly added files within the same commit.
  • If the content similarity exceeds a certain threshold (defaulting to 50%), Git assumes the file was renamed or moved.

So, if lines changes over threshold, it treated as delete & add, I think is unavoidable for some files transfer from .rst to md. The file history still preserved even displayed as delete & add, it's consistent with the purpose of using git mv.

image

@zxiiro zxiiro dismissed their stale review June 4, 2025 16:31

I'm not a reviewer for the docathon.

@zeshengzong zeshengzong marked this pull request as ready for review June 9, 2025 02:20
svekars
svekars reviewed Jun 10, 2025
View reviewed changes
nirajkamal
nirajkamal reviewed Jun 11, 2025
View reviewed changes
nirajkamal
nirajkamal reviewed Jun 11, 2025
View reviewed changes
@zeshengzong
Copy link
Contributor Author

Hi @svekars, please help review the change when available, thanks!

@zeshengzong
Copy link
Contributor Author

@pytorchbot rebase -b main

@pytorchmergebot
Copy link
Collaborator

@pytorchbot started a rebase job onto refs/remotes/origin/main. Check the current status here

@pytorchmergebot
Copy link
Collaborator

Successfully rebased opt/docs/md_1 onto refs/remotes/origin/main, please pull locally before adding more changes (for example, via git checkout opt/docs/md_1 && git pull --rebase)

zeshengzong and others added 7 commits August 8, 2025 16:19
@zeshengzong
Convert to markdown: cpp_extension.rst, cpp_index.rst, cpu.rst, cuda_…
7f44e2d 
…environment_variables.rst, cuda._sanitizer.rst
@zeshengzong
Update
d9c22b3
@zeshengzong
Update
0a98a7a
@svekars @zeshengzong
Update docs/source/cpp_index.md
e8f6a16
@zeshengzong @nirajkamal
Update
3baf284 
Co-authored-by: nirajkamalk <nirajkkamal@gmail.com>
@zeshengzong @nirajkamal
Update
5df0107 
Co-authored-by: nirajkamalk <nirajkkamal@gmail.com>
@zeshengzong
Update
0a519e5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zxiiro zxiiro zxiiro left review comments

@svekars svekars svekars left review comments

@nirajkamal nirajkamal nirajkamal left review comments

Assignees
No one assigned
Labels
docathon-h1-2025 medium Label for medium docathon tasks module: docs Related to our documentation, both in docs/ and docblocks open source topic: not user facing topic category triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Convert to markdown: cpp_extension.rst, cpp_index.rst, cpu.rst, cuda_environment_variables.rst, cuda._sanitizer.rst
7 participants
@zeshengzong @pytorchmergebot @zxiiro @svekars @nirajkamal @pytorchbot @sekyondaMeta