Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated editors integration documentation #4579

Closed
wants to merge 2 commits into from

Conversation

JSuyashRaj
Copy link

Added detailed documentation on PyInstaller which was unavailable. Please review and accept/let me know of any changes. Thank you very much. Happy to be of help! Good day!

@MeGaGiGaGon
Copy link
Collaborator

MeGaGiGaGon commented Feb 19, 2025

Hello, thank you for your contribution to the Black formatter!

I've looked through your changes, which seem to be for fixing this issue #2492, but sadly this does not meet our minimum effort requirements, as the change appears (to me) AI generated, and does not address the actual issue raised by #2492. We expect a minimum level of effort to be put into changes, as we are all volunteering our limited time to this project. I will be closing this PR, however I will also be including below some other points I have given before to similar PRs for #2492. If after reading it you have a more concrete idea of our process/the needed changes, and are willing to put in the effort for a quality contribution, feel free to open a new PR.

Thank you.


You can create a link to another issue/pr by doing #, ie #2492. If you put something along the lines of "Fixes #2492" in your opening PR description, it will link the issue so it is automatically closed on merge. This also works if you edit the message after creation.

I read your changes and #2492, and sadly I don't think your current changes match what #2492 was asking for. According to the one place PyInstaller is mentioned in the docs the binaries are so that people can run black without having to install python. #2492 looks to be wanting more places in the documentation that say "Hey, we have PyInstaller binaries you can use if you don't have/want python". The best places to add those statements would probably be the installation section of the getting started page and the installation section of the readme

Also as pointed out in this comment, if you want to be more ambitious you could also make a dedicated docs section for all the different ways to install black, all of which were listed in the linked comment.

@JSuyashRaj
Copy link
Author

Sorry for not being able to contribute in a meaningful way sir. Thank you very much for reviewing the changes. Have a great day.

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.

2 participants