Integrate Ruff docstring linting for Arm public APIs by Sebastian-Larsson · Pull Request #19934 · pytorch/executorch

Sebastian-Larsson · 2026-06-02T08:54:06Z

Add a RUFF_DOCS lintrunner target scoped to Arm public API files.

cc @digantdesai @freddan80 @per @zingo @oscarandersson8218 @mansnils @robell @rascani

pytorch-bot · 2026-06-02T08:54:10Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR

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

❌ 2 New Failures, 3 Unrelated Failures, 5 Unclassified Failures

As of commit 29cfa49 with merge base a8cfb75 ():

NEW FAILURES - The following jobs have failed:

trunk / test-llama-runner-qnn-linux (fp32, qnn_8a8w, qnn) / linux-job (gh)
RuntimeError: Command docker exec -t 62e0fe2b3e31920cad38038331524d634b28e12c43256ef650ed4da1ba134395 /exec failed with exit code 92
trunk / test-qnn-optimum-model (fp32, efficientnet) / linux-job (gh)
RuntimeError: Command docker exec -t 3f13e54a5b0a980fc10ee7406075834e76c381d516f755675f2a5d6e5ef5fcd8 /exec failed with exit code 92

UNCLASSIFIED FAILURES - DrCI could not classify the following jobs because the workflow did not run on the merge base. The failures may be pre-existing on trunk or introduced by this PR:

Build Aarch64 Linux Wheels / pytorch/executorch / build-wheel-py3_10-cpu-aarch64 (gh) (this job did not run on the merge base, so DrCI cannot tell whether the failure is pre-existing)
/__w/executorch/executorch/pytorch/executorch/backends/apple/coreml/runtime/inmemoryfs/inmemory_filesystem.cpp:722:48: error: ‘inmemoryfs::InMemoryFileSystem::InMemoryNode::Kind’ has not been declared
Build Aarch64 Linux Wheels / pytorch/executorch / upload / upload-wheel-py3_10-cpu-aarch64 (gh) (this job did not run on the merge base, so DrCI cannot tell whether the failure is pre-existing)
Unable to download artifact(s): Artifact not found for name: pytorch_executorch__3.10_cpu_aarch64
Build Windows Wheels / pytorch/executorch / build-wheel-py3_10-cpu (gh) (this job did not run on the merge base, so DrCI cannot tell whether the failure is pre-existing)
ImportError: DLL load failed while importing _portable_lib: The specified module could not be found.
Build Windows Wheels / pytorch/executorch / upload / upload-wheel-py3_10-cpu (gh) (this job did not run on the merge base, so DrCI cannot tell whether the failure is pre-existing)
Unable to download artifact(s): Artifact not found for name: pytorch_executorch__3.10_cpu_x64
trunk / test-models-macos-coreml (mv3) / macos-job (gh) (this job did not run on the merge base, so DrCI cannot tell whether the failure is pre-existing)
RuntimeError: Command bash /Users/ec2-user/runner/_work/_temp/exec_script failed with exit code 1

BROKEN TRUNK - The following jobs failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

pull / unittest / windows / windows-job (gh) (trunk failure)
Process completed with exit code 2.
pull / unittest-editable / windows / windows-job (gh) (trunk failure)
Process completed with exit code 2.
trunk / unittest-release / windows / windows-job (gh) (trunk failure)
Process completed with exit code 2.

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

zingo · 2026-06-02T17:26:36Z

Hi @digantdesai adding Help wanted on this as it would be good to double check this!

digantdesai · 2026-06-03T14:58:47Z

 certifi  # Imported by resolve_buck.py.
 lintrunner==0.12.7
 lintrunner-adapters==0.14.0
+ruff==0.15.4


digantdesai · 2026-06-03T14:59:12Z


+[[linter]]
+code = 'RUFF_DOCS'
+include_patterns = [


curious how bad things would get if I were to run this ET wide? 😅

It would probably result in quite a few errors and warnings 😅 But enabling it one directory at a time shouldn't be too heavy work

create an issue?

Create an issue for this as well as docformatter to grow beyond arm?

digantdesai · 2026-06-03T15:01:30Z

 ]

+[[linter]]
+code = 'RUFF_DOCS'


I also want to make sure if this collides with whatever we use internally, let me run it.

Alright, let me know how it goes

@digantdesai how did it go?

@digantdesai any update?

digantdesai · 2026-06-23T15:42:03Z

 blank = true
+
+[tool.ruff.lint]
+select = ["D"]


Are you planning to expand this in the future?

digantdesai

Apologies for the delay.

Add a RUFF_DOCS lintrunner target scoped to Arm public API files. Configure Ruff to run Google-style pydocstyle rules while ignoring module docstring requirements and docformatter-incompatible rules. Signed-off-by: Sebastian Larsson <sebastian.larsson@arm.com> Change-Id: I4285ff88f37997422391c4950a714934f58e2ad4

Signed-off-by: Sebastian Larsson <sebastian.larsson@arm.com> Change-Id: I05c39f22996ac6ac48150240f27793dbefcebb8c

Sebastian-Larsson requested review from digantdesai and mergennachin as code owners June 2, 2026 08:54

Sebastian-Larsson added partner: arm For backend delegation, kernels, demo, etc. from the 3rd-party partner, Arm release notes: arm Changes to the ARM backend delegate labels Jun 2, 2026

meta-cla 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 Jun 2, 2026

github-actions Bot added ciflow/trunk module: arm Issues related to arm backend labels Jun 2, 2026

zingo added the help wanted Extra attention is needed label Jun 2, 2026

digantdesai reviewed Jun 3, 2026

View reviewed changes

digantdesai approved these changes Jun 3, 2026

View reviewed changes

digantdesai reviewed Jun 3, 2026

View reviewed changes

Sebastian-Larsson force-pushed the ruff_docs branch from 0b29ceb to 9f1268c Compare June 11, 2026 14:02

digantdesai reviewed Jun 23, 2026

View reviewed changes

digantdesai approved these changes Jun 23, 2026

View reviewed changes

Sebastian-Larsson added 2 commits June 26, 2026 16:22

Arm backend: Fix VGF docstring lint failures

29cfa49

Signed-off-by: Sebastian Larsson <sebastian.larsson@arm.com> Change-Id: I05c39f22996ac6ac48150240f27793dbefcebb8c

Sebastian-Larsson force-pushed the ruff_docs branch from 47eb84c to 29cfa49 Compare June 26, 2026 14:23

Sebastian-Larsson merged commit e5f5853 into pytorch:main Jun 26, 2026
504 of 516 checks passed

Uh oh!

Conversation

Sebastian-Larsson commented Jun 2, 2026 • edited by pytorch-bot Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot Bot commented Jun 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

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

❌ 2 New Failures, 3 Unrelated Failures, 5 Unclassified Failures

Uh oh!

zingo commented Jun 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

digantdesai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Sebastian-Larsson commented Jun 2, 2026 •

edited by pytorch-bot Bot

Loading

pytorch-bot Bot commented Jun 2, 2026 •

edited

Loading