From 657f8b8eaa4968c6f28434822d0f063f9c955935 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Adjemian=20=28Argos=29?=
 <stepan@adjemian.eu>
Date: Wed, 19 Feb 2025 10:33:04 +0100
Subject: [PATCH] Complete header doc.

---
 src/@dseries/plot.m | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/src/@dseries/plot.m b/src/@dseries/plot.m
index 2c9c9b6..d44a72e 100644
--- a/src/@dseries/plot.m
+++ b/src/@dseries/plot.m
@@ -1,8 +1,20 @@
 function h = plot(o, varargin)
 
 % Overloads Matlab/Octave's plot function for dseries objects.
+%
+% INPUTS:
+% - o            [dseries]   object containing n time series to be plotted in the same figure.
+% - varargin     [cell]      optionally a second dseries object, and some options to be passed to the plot command.
+%
+% OUTPUTS:
+% - h            [handle]    plot handle.
+%
+% REMARKS:
+% [1] If  n > 1 , additional arguments cannot be passed to the plot function for customization. However, the plot can be modified afterward using the plot handle.
+% [2] If two dseries objects are provided, it is assumed that both contain only one observation (i.e.,  n = 1 ). The function will then plot the second variable against the first.
+
 
-% Copyright © 2013-2017 Dynare Team
+% Copyright © 2013-2025 Dynare Team
 %
 % This file is part of Dynare.
 %
-- 
GitLab