✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

_{Generated for commit: f9e61fa. Link to the linter CI: here}

Hey @adrinjalali , could you please check this PR and merge this ?

@lesteve Could you please check and merge this PR

Hey @lesteve , could you please tell me what is the error in the PR ?

The CI issue is being investigated and hopefully fixed soon in #29771, so it's not related to your PR.

Seems like you put the link to the example at the end of the docstring but I am wondering whether the intent of #26927 is to put the example link before the parameters for example after the "For more details read the User Guide". Otherwise the link to the example is in the middle of a very verbose page, and IMO this does not really help discoverability ... any thoughs on this @adrinjalali?

You can view the rendering of your PR by clicking on "check the rendered doc link" and then to the class you modified the docstring (VotingRegressor) for your last commit: https://output.circle-artifacts.com/output/job/aa86f689-cb7b-4740-851b-f0cb0924a399/artifacts/0/doc/modules/generated/sklearn.ensemble.VotingRegressor.html

@doshi-kevin also I am personally not a big fan of being pinged unless this is really blocking and I happen to be the best person to fix something quickly. Different people have different opinions on this.

I would say waiting roughly a week without answer before pinging is probably a reasonable guideline, see for example this FAQ section

I am really sorry, I will make the changes. Sorry for any inconveniences caused.

@doshi-kevin the issue in #29771 is fixed now. Can you pull the changes from upstream main into your branch?

Hey @marenwestermann , I checked other similar PRs and I believe I have added the link to the correct location in the file. I added a little text of 'please refer to,'. Please check this PR, in case of any changes, I will be happy to do it.

@marenwestermann Any updates on this ?

I agree with @marenwestermann's comment here: https://github.com/scikit-learn/scikit-learn/pull/29724/files#r1743929175
The text could be shortened and doesn't need to be long. That single sentence is enough.

@lesteve it depends on whether the example is focusing on the estimator as a whole, or a specific parameter. I believe in this case having it at the end of the docstring is the right place.

yes, I will make the text shorter.

The only thing you need to add is:

For a more detailed example, refer to :ref:sphx_glr_auto_examples_ensemble_plot_voting_regressor.py.

Hey @adrinjalali , made the changes, sorry for taking too much of your time

Thank you so much @Charlie-XIAO , I have made the changes.

@Charlie-XIAO Noted. I will move the link upwards (above "read more in user guide" line)

@Charlie-XIAO @adrinjalali I have made the change and put the link in the beginning of the page above ...see more User Guide. Please check once. Thank You.

Everything looks good now, thanks @doshi-kevin, I'm enabling auto-merge.