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

Documentation in repo description is outdated #666

Open
gricey432 opened this issue May 25, 2020 · 8 comments
Open

Documentation in repo description is outdated #666

gricey432 opened this issue May 25, 2020 · 8 comments
Assignees

Comments

@gricey432
Copy link

The README.md links to https://python-watchdog.readthedocs.io/ which is up to date, however the repo description (not editable by a pr) links to http://packages.python.org/watchdog/ which is docs for version 0.8.2

@millionhz
Copy link

I feel like the documentation does't have enough explanation. I had to read the source to better understand what is used for what, and to be honest im still a little confused.

@gricey432
Copy link
Author

@BoboTiG this isn't fixed

Capture

Still links to a different url than the README.md

@BoboTiG
Copy link
Collaborator

BoboTiG commented Jul 15, 2020

@danilobellini do you mind regenerating the documentation? It is showing the 0.10.2 version. And with the fix from c36a7df, it should be good then.

@BoboTiG
Copy link
Collaborator

BoboTiG commented Jul 15, 2020

@gricey432 the link on the repository it not editable by us. Only @gorakhargosh can change it.

@danilobellini
Copy link
Collaborator

Sorry guys, I'll do that now!

@danilobellini
Copy link
Collaborator

Regarding the pythonhosted link, I've found this warning: "If you would like to DESTROY any existing documentation hosted at https://pythonhosted.org/watchdog/ there is no undo, as uploading new documentation is no longer supported.". As it seems, no one can update the documentation in the repository description link. And only @gorakhargosh can update that description.

@ingoogni
Copy link

ingoogni commented Sep 2, 2020

I'll add it here as it it also about the documentation.
https://watchdog.readthedocs.io/en/latest/ leads to the 0.9.0 documentation, not to 0.10.3
https://python-watchdog.readthedocs.io/en/v0.10.3/api.html has no doc on several parts of the api
https://python-watchdog.readthedocs.io/en/v0.9.0/api.html also misses these
yet
https://watchdog.readthedocs.io/en/latest/api.html has these api's documented.

@ranggakd
Copy link

ranggakd commented May 3, 2024

Can we get an updated for this? @gorakhargosh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants