DOC Add link to plot_optics.py #26970
Conversation
examples/cluster/plot_optics.py
Outdated
| For an example of usage, see | ||
| :ref:`sphx_glr_auto_examples_cluster_plot_optics.py`. |
There was a problem hiding this comment.
this needs to go to the docstring of the OPTICS class, rather than here, which is in _optics.py
There was a problem hiding this comment.
@adrinjalali I followed your instruction but I really don't getting why some checks failed at the test?
sklearn/cluster/_optics.py
Outdated
| @@ -53,6 +53,9 @@ class OPTICS(ClusterMixin, BaseEstimator): | |||
|
|
|||
| Read more in the :ref:`User Guide <optics>`. | |||
|
|
|||
| For an example of usage, see | |||
| :ref:`sphx_glr_auto_examples_plot_cluster_optics.py`. | |||
There was a problem hiding this comment.
WARNING: undefined label: 'sphx_glr_auto_examples_plot_cluster_optics.py'
change it to:
:ref:`sphx_glr_auto_examples_cluster_plot_optics.py`.
There was a problem hiding this comment.
@greyisbetter Thanks, I tried your suggestion but still there is 2 failing checks in the test.
There was a problem hiding this comment.
Using less extra spaces between paragraph may help. And I think it would be better if the example is at the end of the docstring.
sklearn/cluster/_optics.py
Outdated
| @@ -51,8 +51,7 @@ class OPTICS(ClusterMixin, BaseEstimator): | |||
| cluster order. Note that we do not employ a heap to manage the expansion | |||
| candidates, so the time complexity will be O(n^2). | |||
|
|
|||
| Read more in the :ref:`User Guide <optics>`. | |||
|
|
|||
| Read more in the :ref:`User Guide <optics>`. | |||
There was a problem hiding this comment.
| Read more in the :ref:`User Guide <optics>`. | |
| Read more in the :ref:`User Guide <optics>`. | |
sklearn/cluster/_optics.py
Outdated
|
|
||
| For an example of usage, see :ref:`sphx_glr_auto_examples_cluster_plot_optics.py`. |
There was a problem hiding this comment.
| For an example of usage, see :ref:`sphx_glr_auto_examples_cluster_plot_optics.py`. | |
| For an example of usage, see | |
| :ref:`sphx_glr_auto_examples_cluster_plot_optics.py`. |
There was a problem hiding this comment.
@greyisbetter Thanks, I tried to follow all of the suggestion but still somehow it couldn't pass all the checks!
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com>
Towards #26927
Add link to
plot_optics.py#pyladies-sprint