8000 Fix docstring for torch.signal.windows.nuttall by pytorchbot · Pull Request #134704 · pytorch/pytorch · GitHub
[go: up one dir, main page]
Skip to content

Fix docstring for torch.signal.windows.nuttall #134704

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
Merged
merged 1 commit into from
Aug 28, 2024
Merged

Fix docstring for torch.signal.windows.nuttall #134704

merged 1 commit into from
Aug 28, 2024

Conversation

pytorchbot
Copy link
Collaborator

This partially fixes regression introduced by #124771 but also just improves z_n rendering, by using MathML
In 2.3 it was rendered
as
image

With this change it'll be rendered as

$$z_n = \frac{2 \pi n}{M}$$

@malfet @pytorchbot
Fix docstring for torch.signal.windows.nuttall (#134512)
f0892ec 
This partially fixes regression introduced by #124771 but also just improves `z_n` rendering, by using MathML
In 2.3 it was [rendered](https://pytorch.org/docs/2.3/generated/torch.signal.windows.nuttall.html#torch.signal.windows.nuttall)
as
<img width="177" alt="image" src="https://github.com/user-attachments/assets/2c15d1f9-13ad-483f-bb66-41fa3fa4ba9c">

With this change it'll be [rendered](https://docs-preview.pytorch.org/pytorch/pytorch/134512/generated/torch.signal.windows.nuttall.html#torch.signal.windows.nuttall) as
```math
z_n = \frac{2 \pi n}{M}
```
Pull Request resolved: #134512
Approved by: https://github.com/kit1980, https://github.com/aorenste, https://github.com/atalman

(cherry picked from commit 79b7fff)
This was referenced Aug 28, 2024
Closed
Closed
@pytorch-bot PyTorch Bot
Copy link
pytorch-bot bot commented Aug 28, 2024 •
edited
Loading

🔗 Helpful Links

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

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

❌ 54 Cancelled Jobs, 1 Unrelated Failure

As of commit f0892ec with merge base b66e3f0 (image):

CANCELLED JOBS - The following jobs were cancelled. Please retry:

FLAKY - The following job failed but was likely due to flakiness present on trunk:

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

@malfet malfet merged commit 79c8867 into release/2.4 Aug 28, 2024
35 of 89 checks passed
@github-actions github-actions bot deleted the cherry-pick-134512-by-pytorch_bot_bot_ branch October 2, 2024 02:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@malfet malfet malfet approved these changes

Assignees
No one assigned
Labels
open source
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pytorchbot @malfet
0