Git Product home page Git Product logo

Comments (1)

danyalaytekin avatar danyalaytekin commented on June 2, 2024

Hi @edsnowden, thanks for this report, and for your code and logs which made it straightforward to understand the issue and reproduce the behaviour. Also, that is a very pleasant amount of memory.

For HTML_CodeSniffer: I'm reasonably confident this is the currently intended behaviour of options.rules, going by the name of its non-obvious CLI counterpart, --add-rule, and by this test's name. I agree that rules is not a very descriptive name though, if I'm understanding this correctly, so maybe we should improve how we explain their equivalence.

For axe: --add-rule and options.rules are currently documented as being only for HTML_CodeSniffer, but I think we use this property internally for a different purpose for axe, where the intended behaviour appears to be 'set' rather than 'add', according to the name of the test I just linked, but I'm actually seeing the 'add' behaviour locally for axe too.

Are you comfortable with this behaviour, with the understanding it represents addition rather than replacement? Some other changes we could make:

  1. (breaking) simply rename rules to be clearer; probably not a good idea since it would inconvenience current users of the property
  2. (minor) same as (1), but also leave rules (now an alias for that new property) in place
  3. (minor) explain this better in our documentation, whether in code or markdown. When you first learned about options.rules, where were you looking? We could try to clarify this to readers there

from pa11y.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.