From 1553b66ee4ebc1263831d2353ae307918dadd201 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rog=C3=A9rio=20J=C3=BAnior?= <rogerio.agjunior@gmail.com>
Date: Tue, 5 Dec 2023 04:59:48 -0800
Subject: [PATCH] Update `_process_sequence()` docstring (#219)

Small modification in the documentation of `_process_sequence` to reflect the correct order (`hidden_state`, `cell_state`) of `lstm_states`.

See order here: https://pytorch.org/docs/stable/generated/torch.nn.LSTM.html
---
 sb3_contrib/common/recurrent/policies.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sb3_contrib/common/recurrent/policies.py b/sb3_contrib/common/recurrent/policies.py
index 5e5090b..3fa5940 100644
--- a/sb3_contrib/common/recurrent/policies.py
+++ b/sb3_contrib/common/recurrent/policies.py
@@ -170,7 +170,7 @@ class RecurrentActorCriticPolicy(ActorCriticPolicy):
         Do a forward pass in the LSTM network.
 
         :param features: Input tensor
-        :param lstm_states: previous cell and hidden states of the LSTM
+        :param lstm_states: previous hidden and cell states of the LSTM, respectively
         :param episode_starts: Indicates when a new episode starts,
             in that case, we need to reset LSTM states.
         :param lstm: LSTM object.