Skip to content

Add link to first occurrence of 'black' in tutorial #10301

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.

Sign up for GitHub

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

Jump to bottom
Closed
E3D3 opened this issue Mar 24, 2025 · 5 comments · Fixed by #10303
Closed

Add link to first occurrence of 'black' in tutorial #10301

E3D3 opened this issue Mar 24, 2025 · 5 comments · Fixed by #10303
Labels
Documentation 📗 Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation

Comments

@E3D3
Copy link

E3D3 commented Mar 24, 2025

Current problem

Please explain what 'black' is in the tutorial (on https://pylint.readthedocs.io/en/stable/tutorial.html section "Your First Pylint'ing"), or at least make it a link, pointing to https://github.com/psf/black .
I had to search other pages to find it explained. IMO not good to start a tutorial with.

Desired solution

When I see a new term I want it explained or a link to an explanation.

Additional context

No response
@E3D3 E3D3 added the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Mar 24, 2025
@zenlyj zenlyj added Help wanted 🙏 Outside help would be appreciated, good for new contributors Good first issue Friendly and approachable by new contributors Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation and removed Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling labels Mar 24, 2025
@alexprabhat99 alexprabhat99 mentioned this issue Mar 24, 2025
Merged
@E3D3
Copy link
Author

E3D3 commented Mar 24, 2025

@zenlyj and @alexprabhat99 Thank you

@E3D3
Copy link
Author

E3D3 commented Apr 10, 2025

I still don't see black explained, or linked to an explanation !?

@zenlyj
Copy link
Contributor

zenlyj commented Apr 10, 2025

@Pierre-Sassoulas do we need to backport this change?

@Pierre-Sassoulas
Copy link
Member

We also need to release before the default readthedoc has it, but we're not going to do a release immediately

@E3D3
Copy link
Author

E3D3 commented Apr 10, 2025

@Pierre-Sassoulas thank you for the explanation. I understand it now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation 📗 Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

added black's github link in tutorial alexprabhat99/pylint
3 participants
@Pierre-Sassoulas @E3D3 @zenlyj