Skip to content

docs: replace Black references with ruff-format#12780

Merged
RayBB merged 1 commit into
internetarchive:masterfrom
Shikhar-395:12260/docs/ruff-format-guidance
May 20, 2026
Merged

docs: replace Black references with ruff-format#12780
RayBB merged 1 commit into
internetarchive:masterfrom
Shikhar-395:12260/docs/ruff-format-guidance

Conversation

@Shikhar-395

Copy link
Copy Markdown
Contributor

Follow up to #12778.

Updates stale Python style guidance so docs refer to Ruff for linting and ruff format for formatting instead of Black. Also removes the unused [tool.black] config from pyproject.toml.

Note: root requirements_test.txt already has no Black dependency. The remaining black entry is in vendor/infogami/requirements_test.txt, which belongs to the Infogami submodule and needs an Infogami side PR/submodule bump.

Stakeholders

@RayBB

@mekarpeles

Copy link
Copy Markdown
Member

Thank you for the contribution, @Shikhar-395!

🤖 Copilot has been assigned for an initial review.

The linked issue (#12778) hasn't been triaged yet — triage happens on Mondays and Fridays. There are currently 73 open non-draft PRs ahead of yours.

PR triage checklist (maintainers / Pam)
  • PR description — not empty; explains what the change does and how to verify it
  • References an issue — PR body contains a #NNN reference
    • Linked issue is triaged — has a Priority: * label (not just Needs: Triage)
    • Linked issue is assigned — has at least one assignee
  • Commit history clean — no WIP/fixup/conflict noise; commit messages are meaningful
  • CI passing — no failing check-runs
  • Test cases present — if the change touches substantive logic, test coverage exists or is explained
  • Proof of testing — PR body includes a description of what was tested, a screenshot, or a video

Note

This comment was automatically generated by Pam, Open Library's Project AI Manager, on behalf of @mekarpeles. Pam is designed to provide status visibility, perform basic project management functions and relevant codebase research, and provide actionable feedback so contributors aren't left waiting.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates repository documentation/configuration to reflect the post-Black migration, aligning Python style guidance with Ruff-based linting/formatting and removing leftover Black configuration from pyproject.toml.

Changes:

  • Remove the unused [tool.black] configuration (and related comments) from pyproject.toml.
  • Update AI/dev guidance docs to reference Ruff for linting and Ruff’s formatter instead of Black.
  • Refresh the “bridge” instruction files (AGENTS.md, .github/copilot-instructions.md) to match the canonical docs/ai/README.md.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
pyproject.toml Removes obsolete Black configuration now that formatting is handled via Ruff tooling.
docs/ai/README.md Updates canonical AI/dev documentation to replace Black references with Ruff-based formatting guidance.
AGENTS.md Updates quick-reference guidance to match the Ruff formatter transition.
.github/copilot-instructions.md Updates Copilot quick-reference guidance to match the Ruff formatter transition.
Comments suppressed due to low confidence (1)

AGENTS.md:41

  • Consider naming the formatter as ruff format / “Ruff formatter” rather than “ruff-format” (which is the pre-commit hook id) so developers don’t mistake it for a standalone command.
- **Python:** Ruff for linting and ruff-format for formatting, line length 162, double quotes

Comment thread docs/ai/README.md Outdated
Comment thread AGENTS.md Outdated
Comment thread .github/copilot-instructions.md Outdated
@Shikhar-395 Shikhar-395 force-pushed the 12260/docs/ruff-format-guidance branch from 1ebda2b to 64cb963 Compare May 20, 2026 22:34
@Shikhar-395

Copy link
Copy Markdown
Contributor Author

@RayBB, PTAL

@RayBB RayBB left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Great cleanup thanks!

@RayBB RayBB merged commit 7a9af33 into internetarchive:master May 20, 2026
4 checks passed
@RayBB RayBB self-assigned this May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants