Docs for PostgresNode.__init__() method

Author: zilder

docs/source/testgres.rst

@@ -44,7 +44,10 @@ testgres.exceptions
 testgres.node
 -------------
 
-.. automodule:: testgres.node
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. autoclass:: testgres.node.PostgresNode
+   :members:
+
+   .. automethod:: __init__
+
+.. autoclass:: testgres.node.ProcessProxy
+   :members:

testgres/api.py

@@ -29,16 +29,14 @@
 ...             print(replica.execute('postgres', 'select count(*) from test'))
 PostgresNode(name='...', port=..., base_dir='...')
 [(3,)]
-
-Copyright (c) 2016, Postgres Professional
 """
-
-from functools import wraps
-
 from .node import PostgresNode
 
 
-@wraps(PostgresNode.__init__)
 def get_new_node(name=None, base_dir=None, **kwargs):
+    """
+    Simply a wrapper around :class:`.PostgresNode` constructor.
+    See :meth:`.PostgresNode.__init__` for details.
+    """
     # NOTE: leave explicit 'name' and 'base_dir' for compatibility
     return PostgresNode(name=name, base_dir=base_dir, **kwargs)

testgres/node.py

@@ -92,7 +92,7 @@ def __repr__(self):
 class PostgresNode(object):
     def __init__(self, name=None, port=None, base_dir=None):
         """
-        Create a new node.
+        PostgresNode constructor.
 
         Args:
             name: node's application name.