Update docstring for storage provider class

[c-w]

Update docstring for storage provider class

Description

The docstring listing all the class variables in the storage provider class went out of sync with the actual class variables. This commit fixes that by removing docstring entries for class variables that no longer exist and by adding docstring entries for class variables that have been added.

Status

Done, ready for review.

Checklist (tick everything that applies)

• Code linting (required, can be done after the PR checks)
• Documentation
• Tests
• ICLA (required for bigger changes)

[codecov-io]

Codecov Report

Merging #1201 into trunk will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##            trunk    #1201      +/-   ##
==========================================
+ Coverage   86.21%   86.22%   +<.01%     
==========================================
  Files         348      348              
  Lines       67382    67382              
  Branches     5963     5963              
==========================================
+ Hits        58096    58098       +2     
+ Misses       6853     6851       -2     
  Partials     2433     2433

Impacted Files	Coverage Δ
libcloud/storage/types.py	100% <ø> (ø)	⬆️
libcloud/test/compute/test_ec2.py	97.93% <0%> (+0.15%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 694b021...1b82868. Read the comment docs.

[pquentin]

Thanks! Do you know if this list appears in the documentation? I think the important list to maintain is https://libcloud.readthedocs.io/en/latest/storage/supported_providers.html, and we should try to avoid others if possible?

[c-w]

Hi @pquentin, thanks for the reply. That list indeed looks up to date and in sync with the changes suggested in this pull request.

I believe there still might be value in also having the class docstring since this enables getting context about all the supported providers in an IDE such as PyCharm via auto-completion and go-to-definition.

If you wish to avoid maintaining two lists of supported providers, maybe it would be worth removing the listing in the docstring and instead add a link to the official documentation instead?

[pquentin]

@c-w I don't use AWS storage, so that's your call! I'd be happy to merge this, or replace by a link. Please tell me.

[c-w]

@pquentin If we could merge it as is, that would be great. Would really help with discoverability of all the storage providers in IDEs (e.g. I was just exploring the library and auto-completion didn't tell me that there's support for Azure Blobs). Thanks!

[pquentin]

Thanks! Merged in trunk. ✨