Update copyright year. Add SoftLayerListResult to docs

Kevin McDonald · Kevin McDonald · commit 05ae21611efd · 2015-12-09T16:29:17.000-06:00
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.
+Copyright (c) 2015 SoftLayer Technologies, Inc. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/SoftLayer/__init__.py b/SoftLayer/__init__.py
@@ -8,7 +8,7 @@
         >>> import SoftLayer
         >>> client = SoftLayer.create_client_from_env(username="username",
                                                       api_key="api_key")
-        >>> resp = client['Account'].getObject()
+        >>> resp = client.call('Account', 'getObject')
         >>> resp['companyName']
         'Your Company'
 
@@ -27,7 +27,15 @@
 __version__ = consts.VERSION
 __author__ = 'SoftLayer Technologies, Inc.'
 __license__ = 'MIT'
-__copyright__ = 'Copyright 2014 SoftLayer Technologies, Inc.'
-__all__ = ['BaseClient', 'create_client_from_env', 'Client',
-           'BasicAuthentication', 'SoftLayerError', 'SoftLayerAPIError',
-           'API_PUBLIC_ENDPOINT', 'API_PRIVATE_ENDPOINT']
+__copyright__ = 'Copyright 2015 SoftLayer Technologies, Inc.'
+__all__ = [
+    'BaseClient',
+    'create_client_from_env',
+    'Client',
+    'BasicAuthentication',
+    'SoftLayerError',
+    'SoftLayerAPIError',
+    'SoftLayerListResult',
+    'API_PUBLIC_ENDPOINT',
+    'API_PRIVATE_ENDPOINT',
+  ]
diff --git a/SoftLayer/transports.py b/SoftLayer/transports.py
@@ -26,6 +26,7 @@
     'RestTransport',
     'TimingTransport',
     'FixtureTransport',
+    'SoftLayerListResult',
 ]
 
 REST_SPECIAL_METHODS = {
@@ -85,10 +86,14 @@ def __init__(self):
 
 
 class SoftLayerListResult(list):
-    """A SoftLayer list result."""
+    """A SoftLayer API list result."""
 
     def __init__(self, items, total_count):
+
+        #: total count of items that exist on the server. This is useful when
+        #: paginating through a large list of objects.
         self.total_count = total_count
+
         super(SoftLayerListResult, self).__init__(items)
 
 
diff --git a/docs/api/client.rst b/docs/api/client.rst
@@ -165,4 +165,4 @@ API Reference
 -------------
 
 .. automodule:: SoftLayer
-	:members:
+    :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -37,12 +37,11 @@ Contributing
 
 External Links
 --------------
-.. toctree::
 
-   SoftLayer API Documentation <http://developer.softlayer.com/reference/softlayerapi>
-   Source on GitHub <https://github.com/softlayer/softlayer-python>
-   Issues <https://github.com/softlayer/softlayer-python/issues>
-   Pull Requests <https://github.com/softlayer/softlayer-python/pulls>
-   PyPI <https://pypi.python.org/pypi/softlayer/>
-   Twitter <https://twitter.com/SoftLayerDevs>
-   #softlayer on freenode <irc://irc.freenode.net/#softlayer>
+* `SoftLayer API Documentation <http://developer.softlayer.com/reference/softlayerapi>`_
+* `Source on GitHub <https://github.com/softlayer/softlayer-python>`_
+* `Issues <https://github.com/softlayer/softlayer-python/issues>`_
+* `Pull Requests <https://github.com/softlayer/softlayer-python/pulls>`_
+* `PyPI <https://pypi.python.org/pypi/softlayer/>`_
+* `Twitter <https://twitter.com/SoftLayerDevs>`_
+* `#softlayer on freenode <irc://irc.freenode.net/#softlayer>`_

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (c) 2014 SoftLayer Technologies, Inc. All rights reserved.`
	`1`	`+Copyright (c) 2015 SoftLayer Technologies, Inc. All rights reserved.`
`2`	`2`
`3`	`3`	`Permission is hereby granted, free of charge, to any person obtaining a copy`
`4`	`4`	`of this software and associated documentation files (the "Software"), to deal`