[DOC] Fixed Issue #3826 - incomplete ForecastingPipeline docstring

[darshitsharma]

Fixes #3826 - the docstring of ForecastingPipeline was incomplete.
This PR adds a complete docstring.

[fkiraly]

Thanks! This is helpful!

What was meant in the issue was the description of the algorithm, what happens in fit etc.

Kindly have a look at TransformedTargetForecaster please, that is how it should look like.

[darshitsharma]

Hello @fkiraly ,
I applied changes the way you mentioned. I am new to open-source and would like to have your guidance here.

[fkiraly]

Thanks for your work!

I would recommend, have a look at TransformedTargetForecaster please, that is how it should look like.

In more detail, it would be great if you could describe how the steps are applied in sequence, for fit and predict.

[darshitsharma]

In ForecastingPipeline, described the working of predict and fit in the way they are described in TransformedTargetForecaster.

[fkiraly]

Thanks!

Can you kindly format the docstrings so that you do not exceed line length of 80 symbols?
Also, kindly don't indent too much, or it will look strange when it renders.

[darshitsharma]

Hi,
I checked that the line wrap was 81 characters instead of 80 characters, corrected my mistake, and removed unnecessary indentation.

[fkiraly]

Thanks for your contribution!

To get this merged, kindly make sure your linting runs, guideline here:
https://www.sktime.org/en/stable/developer_guide/coding_standards.html

[darshitsharma]

Hey @fkiraly,
I am using Visual Studio Code and I have installed all dependencies for sktime to use pre-commit.
The linting error is with flake8 max-line-length=88. Can you suggest something to resolve this?

[fkiraly]

Can you suggest something to resolve this?

The general approach would be to look up the error code in flake8 - in your case E501 and check what you need to do.

In this case, it says for of your lines are too long. The file and line number is given in the error message.

The action you have to carry out is to find those lines and ensure they are not longer than 88 characters, e.g., by introducing a sufficient amount of newlines.

[fkiraly]

Nice, thanks a lot!

I left some comments in the docstring, some details need to be corrected or sharpened.

[fkiraly]

@darshitsharma, thanks!
I made some small changes to make the docstring more similar to TransformedTargetForecaster, your contribution is much appreciated!

[darshitsharma]

@fkiraly , Thanks! for being so helpful throughout. I learned a lot about documenting code here. I hope to learn more from you and contribute to sktime.

[fkiraly]

(see above)