add doc string comments re: Provider sort ordering Closes #748
Signed-off-by: Tomaz Muraus <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/02dc1303 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/02dc1303 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/02dc1303 Branch: refs/heads/trunk Commit: 02dc1303532dcc8245af94b0dcab3409c376096e Parents: 50c7711 Author: Ken Dreyer <[email protected]> Authored: Wed Apr 13 10:42:13 2016 -0600 Committer: Tomaz Muraus <[email protected]> Committed: Thu Apr 14 18:48:33 2016 +0200 ---------------------------------------------------------------------- libcloud/backup/types.py | 6 ++++++ libcloud/compute/types.py | 3 +++ libcloud/container/types.py | 6 ++++++ libcloud/dns/types.py | 6 ++++++ libcloud/loadbalancer/types.py | 5 +++++ libcloud/storage/types.py | 3 +++ 6 files changed, 29 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/02dc1303/libcloud/backup/types.py ---------------------------------------------------------------------- diff --git a/libcloud/backup/types.py b/libcloud/backup/types.py index 022301a..8a4f987 100644 --- a/libcloud/backup/types.py +++ b/libcloud/backup/types.py @@ -21,6 +21,12 @@ __all__ = [ class Provider(object): + """ + Defines for each of the supported providers + + Non-Dummy drivers are sorted in alphabetical order. Please preserve this + ordering when adding new drivers. + """ DUMMY = 'dummy' DIMENSIONDATA = 'dimensiondata' EBS = 'ebs' http://git-wip-us.apache.org/repos/asf/libcloud/blob/02dc1303/libcloud/compute/types.py ---------------------------------------------------------------------- diff --git a/libcloud/compute/types.py b/libcloud/compute/types.py index 5f53cbd..43e6fd8 100644 --- a/libcloud/compute/types.py +++ b/libcloud/compute/types.py @@ -59,6 +59,9 @@ class Provider(Type): """ Defines for each of the supported providers + Non-Dummy drivers are sorted in alphabetical order. Please preserve this + ordering when adding new drivers. + :cvar DUMMY: Example provider :cvar ABIQUO: Abiquo driver :cvar ALIYUN_ECS: Aliyun ECS driver. http://git-wip-us.apache.org/repos/asf/libcloud/blob/02dc1303/libcloud/container/types.py ---------------------------------------------------------------------- diff --git a/libcloud/container/types.py b/libcloud/container/types.py index 61b1c2e..bddca7f 100644 --- a/libcloud/container/types.py +++ b/libcloud/container/types.py @@ -40,6 +40,12 @@ class Type(object): class Provider(object): + """ + Defines for each of the supported providers + + Non-Dummy drivers are sorted in alphabetical order. Please preserve this + ordering when adding new drivers. + """ DUMMY = 'dummy' DOCKER = 'docker' ECS = 'ecs' http://git-wip-us.apache.org/repos/asf/libcloud/blob/02dc1303/libcloud/dns/types.py ---------------------------------------------------------------------- diff --git a/libcloud/dns/types.py b/libcloud/dns/types.py index 35994e7..d1fac12 100644 --- a/libcloud/dns/types.py +++ b/libcloud/dns/types.py @@ -30,6 +30,12 @@ __all__ = [ class Provider(object): + """ + Defines for each of the supported providers + + Non-Dummy drivers are sorted in alphabetical order. Please preserve this + ordering when adding new drivers. + """ DUMMY = 'dummy' AURORADNS = 'auroradns' BUDDYNS = 'buddyns' http://git-wip-us.apache.org/repos/asf/libcloud/blob/02dc1303/libcloud/loadbalancer/types.py ---------------------------------------------------------------------- diff --git a/libcloud/loadbalancer/types.py b/libcloud/loadbalancer/types.py index 6e3340a..391fdf7 100644 --- a/libcloud/loadbalancer/types.py +++ b/libcloud/loadbalancer/types.py @@ -35,6 +35,11 @@ class LibcloudLBImmutableError(LibcloudLBError): class Provider(object): """ + Defines for each of the supported providers + + Non-Dummy drivers are sorted in alphabetical order. Please preserve this + ordering when adding new drivers. + :cvar ALIYUN_SLB: Aliyun SLB loadbalancer driver """ ALIYUN_SLB = 'aliyun_slb' http://git-wip-us.apache.org/repos/asf/libcloud/blob/02dc1303/libcloud/storage/types.py ---------------------------------------------------------------------- diff --git a/libcloud/storage/types.py b/libcloud/storage/types.py index 0879934..c4c61bd 100644 --- a/libcloud/storage/types.py +++ b/libcloud/storage/types.py @@ -34,6 +34,9 @@ class Provider(object): """ Defines for each of the supported providers + Non-Dummy drivers are sorted in alphabetical order. Please preserve this + ordering when adding new drivers. + :cvar DUMMY: Example provider :cvar ALIYUN_OSS: Aliyun OSS storage driver :cvar AURORAOBJECTS: AuroraObjects storage driver
