Skip to content

ruff.toml: the E501 comment says line length is handled elsewhere, and it is not #79

Description

@LeyckerS

This issue is reserved for someone who has never had a pull request merged on GitHub before. If you have contributed before, please leave it — the roadmap has plenty of other work.

There is no programming here. You are changing one line of a comment. The point is to walk you through the process once.

The problem

ruff.toml sets a maximum line length and then switches the check for it off. The comment claims the length is "handled above via line-length instead" — but the line-length setting is the value that check reads. Turning the check off does not move the enforcement somewhere else; it removes it. The file tells the next reader something untrue.

The change

File: ruff.tomlline 6

Currently:

    "E501",  # line length - handled above via line-length instead

Change it to:

    "E501",  # line length is not enforced: ruff format is not run in CI

That is the whole change. One line.

How to do it, step by step

  1. Click Fork at the top right of this repository. This gives you your own copy.
  2. In your copy, click on ruff.toml to open it, then click the pencil icon to edit.
  3. Find line 6 and replace it with the new text above.
  4. Scroll down. Under Commit changes, write a short message such as docs(ruff): correct the E501 comment and click Propose changes.
  5. On the next screen click Create pull request, write Closes #79 in the description, and submit it.

You never have to install anything or run anything. Steps 1 to 5 all happen in the browser.

Before you start

Comment here saying you are taking it, so nobody else starts the same change. Then go ahead — you do not need to wait for a reply.

If you get stuck at any step, say so in a comment. That is completely fine and it is the point of this issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfirst-timers-onlyReserved for someone who has never contributed to open source beforehelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions