Skip to content

Add scripts/ & benchmarks/ to directories checked by scripts/pylint#1047

Merged
mhucka merged 11 commits into
tensorflow:masterfrom
mhucka:lint-more
May 3, 2026
Merged

Add scripts/ & benchmarks/ to directories checked by scripts/pylint#1047
mhucka merged 11 commits into
tensorflow:masterfrom
mhucka:lint-more

Conversation

@mhucka
Copy link
Copy Markdown
Member

@mhucka mhucka commented Apr 14, 2026

This adds ./scripts and ./benchmarks to directories where the linter is run by scripts/lint_all.sh.

Additional changes in a couple of other files are part of this PR because running the linter on those files resulted in linting errors that the changes fix.

mhucka added 3 commits April 14, 2026 21:29
This adds ./scripts and ./benchmarks to directories where the linter is
run.
This puts the code into a function instead of running the loop at the
top level of the file. This makes pylint happier.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request refactors several utility scripts to improve code organization and linting coverage. Changes include adding docstrings to build_docs.py, wrapping the notebook formatting logic into a function in format_ipynb.py, and extending the linting script to include the benchmarks and scripts directories. A review comment suggests moving the notebook discovery logic inside the function to prevent side effects during import.

Comment thread scripts/format_ipynb.py Outdated
@mhucka mhucka marked this pull request as ready for review April 14, 2026 23:08
@mhucka mhucka requested a review from MichaelBroughton April 14, 2026 23:17
@mhucka mhucka changed the title Run pylint on scripts/ and benchmarks/ too Add scripts/ & benchmarks/ to directories checked by scripts/pylint Apr 15, 2026
@mhucka mhucka added the area/devops Involves build systems, Make files, Bazel files, continuous integration, and/or other DevOps topics label Apr 16, 2026
@mhucka mhucka enabled auto-merge May 3, 2026 05:56
@mhucka mhucka added this pull request to the merge queue May 3, 2026
Merged via the queue into tensorflow:master with commit 24ca36e May 3, 2026
5 checks passed
@mhucka mhucka deleted the lint-more branch May 3, 2026 07:07
mhucka added a commit to mhucka/quantum that referenced this pull request May 12, 2026
…low#1038)

Scripts and workflows that run `yapf` currently each add the option
`--style=google` to the invocation of `yapf`. To follow best practices,
this PR adds a `.style.yapf` configuration file at the top level of the
project to set the style, and removes the flag from where it was added
on the command line explicitly.

The use of a config file has the following benefits:

- It lets tools like IDEs discover the setting automatically.
- It reduces the chances that developers will forget to add the flag
when they run `yapf` directly on the command line for quick checks, or
write new scripts that use `yapf`.
- It communicates intentions more clearly to new contributors.

Removing the flag from the scripts is not strictly necessary (everything
will work the same if there is both a config file and the flag is passed
to `yapf`). However, if a config file is used, it's better for
maintainability and consistency to also remove the flag from individual
invocations.

Note: the CI will fail the lint check until PR tensorflow#1047 is merged.

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/devops Involves build systems, Make files, Bazel files, continuous integration, and/or other DevOps topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants