Skip to content

README for Tools directory out of date #102110

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

Closed
stefan6419846 opened this issue Feb 21, 2023 · 5 comments
Closed

README for Tools directory out of date #102110

stefan6419846 opened this issue Feb 21, 2023 · 5 comments
Labels
docs Documentation in the Doc dir easy

Comments

@stefan6419846
Copy link
Contributor

stefan6419846 commented Feb 21, 2023

Documentation

Looking at the README of the Tools directory (https://github.com/python/cpython/blob/main/Tools/README), it seems like it is not really up-to-date with the actual directory content:

  • Directories like wasm do not appear inside it.
  • The parser directory is documented, but has been removed in 27fc3b6

Some subdirectories (like Tools/scripts) have README files which are out-of-date as well.

Linked PRs

@stefan6419846 stefan6419846 added the docs Documentation in the Doc dir label Feb 21, 2023
@sobolevn sobolevn added the easy label Feb 21, 2023
@sobolevn
Copy link
Member

@stefan6419846 this can be a great first PR! Do you want to fix it? :)

@stefan6419846
Copy link
Contributor Author

I might have a further look at this if I find some more time to do so, although I am not really familiar with the corresponding tools directories and its content.

@PrajwalNeupane
Copy link

Hey, I am interested in trying to fix this. Please assign it to me and I will get started right away.

@arhadthedev
Copy link
Member

@PrajwalNeupane It's an open project, no preliminary assignment is required. The only thing you need is to follow the contributor's manual at https://devguide.python.org/ where conventions and processes are described.

@Missoupro
Copy link
Contributor

Hi, I already added a PR to fix this. Hope will be okey, if not, i still available to update it.

miss-islington pushed a commit that referenced this issue Mar 30, 2023
Added missing descriptions of some tools.

Automerge-Triggered-By: GH:hugovk
@hugovk hugovk closed this as completed Mar 30, 2023
warsaw pushed a commit to warsaw/cpython that referenced this issue Apr 11, 2023
Added missing descriptions of some tools.

Automerge-Triggered-By: GH:hugovk
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Development

No branches or pull requests

6 participants