1736560 - Codespell incorrectly fixes aArg in documentation

Status: NEW

(Developer Infrastructure :: Lint and Formatting, task, P2)

Description

[Mark Banner (:standard8)]

Running ./mach lint -l codespell --fix causes the following change to dom/docs/webIdlBindings/index.rst:

diff --git a/dom/docs/webIdlBindings/index.rst b/dom/docs/webIdlBindings/index.rst
index acc9eb647c1d1..26d84760c7827 100644
--- a/dom/docs/webIdlBindings/index.rst
+++ b/dom/docs/webIdlBindings/index.rst
@@ -211,7 +211,7 @@ will require these method declarations:
 
    class MyClass
    {
-     void DoSomething(int32_t aNumber);
+     void DoSomething(int32_t a number);
      double DoSomething(MyClass* aOtherInstance);
 
      already_AddRefed<MyInterface> DoSomethingElse(Optional<int32_t> aMaybeNumber,

Comment 1

[Andrew Halberstadt [:ahal]]

This is happening because we have some post processing to ignore this type of error here:
https://searchfox.org/mozilla-central/rev/36aa22c7ea92bd3cf7910774004fff7e63341cf5/tools/lint/spell/__init__.py#58

But since this happens after the fact, by the time we hit this check the file has already been fixed when --fix is used. I'm not sure how to solve this..