search

canonical / pylxd

Python module for LXD
https://pylxd.readthedocs.io/en/latest/
Apache License 2.0
256 stars 135 forks source link

Confusing default version in the official documentation #447

Open makedin opened 3 years ago

makedin commented 3 years ago

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 commented 1 year ago

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!