GithubHelp home page GithubHelp logo

Unreadable variable names about sunfish HOT 4 CLOSED

thomasahle avatar thomasahle commented on May 16, 2024
Unreadable variable names

from sunfish.

Comments (4)

abhinuvpitale avatar abhinuvpitale commented on May 16, 2024

Adding a flake8 test would help this codebase.

from sunfish.

thomasahle avatar thomasahle commented on May 16, 2024

I agree with you in general, and it's possible that the code should be rewritten that way. For this project I have instead tried to keep everything small, but consistent. Having longer variable names would make some lines too long, and I don't want to split them up.

I agree that some documentation would be nice though. Like wc means "white casting", bc "black castling", i and j are always "from square" and "too square", p and q are "from piece" and "too piece".

from sunfish.

Recursing avatar Recursing commented on May 16, 2024

I think names like i and j would be very easy to improve, would you be willing to accept a pull request that tries to improve readability without breaking the 80 character limit?

Also using black or autopep8 would make the code more consistent without impacting the line number

from sunfish.

thomasahle avatar thomasahle commented on May 16, 2024

Fair, better names for i and j are a good idea. Maybe fs, ts to fit with the convention? :-)

I think autopep8 and black will disagree with the use of inline ifs in sunfish.

But I'm happy to discuss any pull request.

from sunfish.

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.