From e171c4000e382e17891ab675028677e5a60b60d8 Mon Sep 17 00:00:00 2001
From: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com>
Date: Thu, 5 Mar 2020 22:25:18 -0500
Subject: [PATCH] fix Trainer docs example indent and warnings (#1065)

* fix example indent and warnings

* appease the linter
---
 pytorch_lightning/trainer/__init__.py | 30 ++++++++++++++++-----------
 1 file changed, 18 insertions(+), 12 deletions(-)

diff --git a/pytorch_lightning/trainer/__init__.py b/pytorch_lightning/trainer/__init__.py
index 3927ec65..39cced3a 100644
--- a/pytorch_lightning/trainer/__init__.py
+++ b/pytorch_lightning/trainer/__init__.py
@@ -198,10 +198,10 @@ default_save_path
 
 Default path for logs and weights when no logger/ckpt_callback passed
 
-    Example::
+Example::
 
-        # default used by the Trainer
-        trainer = Trainer(default_save_path=os.getcwd())
+    # default used by the Trainer
+    trainer = Trainer(default_save_path=os.getcwd())
 
 distributed_backend
 ^^^^^^^^^^^^^^^^^^^
@@ -327,8 +327,10 @@ Example::
     # default used by the Trainer
     trainer = Trainer(gradient_clip_val=0.0)
 
-gradient_clip
-.. warning: .. deprecated:: 0.5.0
+
+gradient_clip:
+
+.. warning:: .. deprecated:: 0.5.0
     Use `gradient_clip_val` instead. Will remove 0.8.0.
 
 log_gpu_memory
@@ -391,7 +393,7 @@ Example::
     # default used by the Trainer
     trainer = Trainer(max_epochs=1000)
 
-max_nb_epochs
+max_nb_epochs:
 
 .. warning:: .. deprecated:: 0.5.0
     Use `max_epochs` instead. Will remove 0.8.0.
@@ -444,7 +446,7 @@ Example::
     # to train on 8 nodes
     trainer = Trainer(num_nodes=8)
 
-nb_gpu_nodes
+nb_gpu_nodes:
 
 .. warning:: .. deprecated:: 0.5.0
     Use `num_nodes` instead. Will remove 0.8.0.
@@ -465,8 +467,9 @@ Example::
     trainer = Trainer(num_sanity_val_steps=0)
 
 nb_sanity_val_steps:
-    .. warning:: .. deprecated:: 0.5.0
-        Use `num_sanity_val_steps` instead. Will remove 0.8.0.
+
+.. warning:: .. deprecated:: 0.5.0
+    Use `num_sanity_val_steps` instead. Will remove 0.8.0.
 
 num_tpu_cores
 ^^^^^^^^^^^^^
@@ -629,13 +632,16 @@ Example::
     # default used by the Trainer
     trainer = Trainer(row_log_interval=10)
 
-add_row_log_interval
+
+add_row_log_interval:
+
 .. warning:: .. deprecated:: 0.5.0
     Use `row_log_interval` instead. Will remove 0.8.0.
 
 use_amp:
-    .. warning:: .. deprecated:: 0.6.1
-        Use `precision` instead. Will remove 0.8.0.
+
+.. warning:: .. deprecated:: 0.6.1
+    Use `precision` instead. Will remove 0.8.0.
 
 show_progress_bar
 ^^^^^^^^^^^^^^^^^