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

Confusing default version in the official documentation #447

Open
makedin opened this issue Jan 8, 2021 · 1 comment
Open

Confusing default version in the official documentation #447

makedin opened this issue Jan 8, 2021 · 1 comment

Comments

@makedin
Copy link

makedin commented Jan 8, 2021

The official documentation defaults to v:latest, which is not version 2.2.11, the release marked as "latest" here in GitHub. (I realize that Read the Docs and GitHub use just use the word in different senses, so there isn't much to be done about that.)

The page on installation does not make things any clearer, as it suggests using pip install pylxd. Running that command (even with --pre) installs version 2.2.11 of pylxd.

Seeing how the 'latest' version referred to by the docs has not been released at all, it would seem natural to make the default version of the documentation be 'stable' (currently 2.2.11) and the documentation for 'latest' to show a clear warning that it refers to an unreleased version (the installation page could use some work too, as it is simply wrong right now).

@sirkadirov
Copy link

Hi! As a newbie in using pylxd I want to give something good to this project and you're right - the docs are slightly outdated and limited, so to find something I need to dive in source code of the library... Maybe I'll make a PR this summer, when I finish my exams and bachelor's. I'd appreciate any pointers on what you'd like to see in the docs beyond what you've already said. Thanks!

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

No branches or pull requests

2 participants