[MRG] DOC: Add SLEP and Governance in dev docs by bharatr21 · Pull Request #13634 · scikit-learn/scikit-learn

bharatr21 · 2019-04-13T15:43:18Z

Reference SLEP and Governance in dev docs as per #13268

Reference Issues/PRs

Fixes #13268

What does this implement/fix? Explain your changes.

Reference SLEP and Governance in dev docs

jnothman

Thanks!

doc/glossary.rst

jnothman · 2019-04-15T02:53:38Z

doc/developers/contributing.rst

+Governance
+----------
+The decision making process and governance structure of scikit-learn is laid
+out in the `governance document <https://github.com/scikit-learn/scikit-learn/blob/master/doc/governance.rst>`_.


There should be no need to use a full URL reference. :ref:`governance` should suffice

jnothman · 2019-04-15T02:54:02Z

doc/developers/contributing.rst

 <code_review>` are very valuable contributions that decrease the burden on the
 project maintainers.

+


No need for this blank line

jnothman · 2019-04-15T02:54:29Z

doc/developers/contributing.rst


+In case a contribution/issue involves changes to the API principles
+or changes to dependencies or supported versions, a
+`SLEP <https://github.com/scikit-learn/scikit-learn/blob/master/doc/governance.rst#enhancement-proposals-sleps>`_,where a SLEP must be submitted as a pull-request to


Please add a link anchor within the governance document and use :ref: here

jnothman · 2019-04-15T02:54:39Z

doc/developers/contributing.rst

+`SLEP <https://github.com/scikit-learn/scikit-learn/blob/master/doc/governance.rst#enhancement-proposals-sleps>`_,where a SLEP must be submitted as a pull-request to
+`enhancement_proposals <https://github.com/scikit-learn/enhancement_proposals/>`_
+using the `SLEP template <https://github.com/scikit-learn/enhancement_proposals/blob/master/slep_template.rst>`_
+and follows the decision-making process outlined in the `governance document <https://github.com/scikit-learn/scikit-learn/blob/master/doc/governance.rst>`_.


Use :ref:

Currently could not find/create anchors for the scikit-learn/enhancement-proposals folder, so I've retained the full URLs for those cases alone, otherwise requested changes are incorporated.

jnothman · 2019-04-15T08:27:52Z

https://scikit-learn-enhancement-proposals.readthedocs.io might be appropriate

ogrisel

I found some issues with the generated links:

ogrisel · 2019-04-17T11:41:35Z

doc/glossary.rst

+    SLEPs
+        Changes to the API principles and changes to dependencies or supported
+        versions happen via a `SLEP <governance/#enhancement-proposals-sleps>`_ and follows the
+        decision-making process outlined in the `governance document <governance>`_.


Both this link and the previous one are broken in the rendered HTML:

https://54937-843222-gh.circle-artifacts.com/0/doc/glossary.html#term-slep

For the former you probably need to use:

... versions happen via a `SLEP <slep>`_ and follows the ...

I do not understand why the second link (targeting the "governance" reference) does not work. The doc/governance.rst file correctly includes the following line before its heading:

.. _governance:

This reference is reachable as expected at:

https://54937-843222-gh.circle-artifacts.com/0/doc/governance.html#governance

and I do not see a typo in the following syntax:

decision-making process outlined in the `governance document <governance>`_.

Maybe trying to be more explicit with the following would work?

decision-making process outlined in the :ref:`governance document <governance>`.

The syntax:

`governance document <governance>`_

is actually wrong. I confirmed it should be:

:ref:`governance document <governance>`

I found other occurrences of this mistake in our documentation. I will issue another PR to fix those.

ogrisel · 2019-04-17T11:43:38Z

doc/developers/contributing.rst

+Governance
+----------
+The decision making process and governance structure of scikit-learn is laid
+out in the governance document :ref:`governance`.


Please insert a colon before the :ref: marker:

... out in the governance document: :ref:governance.

The :ref: marker is replaced by the title of the referenced section in the rendered HTML:

https://54937-843222-gh.circle-artifacts.com/0/doc/developers/contributing.html#governance

ogrisel · 2019-04-17T11:55:17Z

doc/developers/contributing.rst

+:ref:`slep`, where a SLEP must be submitted as a pull-request to
+`enhancement proposals <https://scikit-learn-enhancement-proposals.readthedocs.io>`_
+using the `SLEP template <https://scikit-learn-enhancement-proposals.readthedocs.io/en/latest/slep_template.html>`_
+and follows the decision-making process outlined in the governance document :ref:`governance`.


Here again please please insert a colon before :ref.

DOC Adds recent core devs to _contributors.rst (#13640) DOC t-SNE perplexity docstring update (#13069) FIX feature importances in random forests sum up to 1 (#13636) DOC Removed a typo from the examples of normalized_mutual_info_score (#13646) MAINT: n_jobs=-1 replaced with n_jobs=4 in tests (#13644) This change is to work around the hang #12263 afflicting Windows on machines with > 62 hyperthreads. Add parameter for stacking missing indicator into iterative imputer (#13601) FIX ignore single node trees in gbm's feature importances (#13620) DOC typo in sklearn.utils.extmath.weighted_mode (#13655) 1.5+2 = 3.5, not 3. ENH Extension of v_measure_score metric to include beta parameter (#13607) BUG Fix missing 'const' in a few memoryview declaration in trees. (#13626) BLD: check OpenMP support and add a switch to build without it (#13543) FIX initialise Birch centroid_ in all cases (#13651) DOC Improve performance of the plot_rbm_logistic_classification.py example (#13383) (#13648) MNT Import linear assignment from scipy (#13465) DOC Fixes formatting issue in webkit (#13657) Fixing parameter description (for assume_centered) (#13456) * Fixing parameter description (for assume_centered) Fixing parameter description (for assume_centered) * Update shrunk_covariance_.py * Update empirical_covariance_.py MAINT Unvendor joblib (#13531) Improve comment in setup.py (#13661) MAINT Replace absolute imports with relative imports (#13653) [MRG] Fix various solver issues in ridge_regression and Ridge classes (#13363) [MRG + 1] Fix pprint ellipsis (#13436) DOC Remove space in "cross-entropy" (#13671) FIX broken references in documentation (#13664) DOC Remove synonyms in documentation of linear models (#13663) MNT Correctly handle deprecated attribute warnings and docstrings (#13635) Deprecate "warn_on_dtype" from check_array (#13382) Fix MultiOutputClassifier checking for predict_proba method of base estimator (#12222) fix small latex issue (#13680) Fix sample_weight in label_ranking_average_precision_score (#13447) DOC Emeritus core devs final call (#13673) ENH Add verbose option to Pipeline, FeatureUnion, and ColumnTransformer (#11364)

bharatr21 · 2019-04-22T06:10:54Z

Closing this PR on account of a messed up rebase

DOC: Add SLEP and Governance in dev docs

0f18654

jnothman reviewed Apr 15, 2019

View reviewed changes

Some ref changes acc to @jnothman

7a0ab49

Update enhancement proposal links

68b202e

jnothman approved these changes Apr 15, 2019

View reviewed changes

ogrisel requested changes Apr 17, 2019

View reviewed changes

ogrisel mentioned this pull request Apr 17, 2019

[MRG] fix broken references in documentation #13664

Merged

bharatr21 added 2 commits April 22, 2019 11:36

Added changes as proposed by @ogrisel

a6e234b

bharatr21 closed this Apr 22, 2019

bharatr21 mentioned this pull request Apr 22, 2019

[MRG] DOC: Add SLEP and Governance in Dev Docs #13688

Merged

		<code_review>` are very valuable contributions that decrease the burden on the
		project maintainers.

Uh oh!

Conversation

bharatr21 commented Apr 13, 2019

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Uh oh!

jnothman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jnothman Apr 15, 2019

Choose a reason for hiding this comment

Uh oh!

jnothman Apr 15, 2019

Choose a reason for hiding this comment

Uh oh!

jnothman Apr 15, 2019

Choose a reason for hiding this comment

Uh oh!

jnothman Apr 15, 2019

Choose a reason for hiding this comment

Uh oh!

bharatr21 Apr 15, 2019

Choose a reason for hiding this comment

Uh oh!

jnothman commented Apr 15, 2019 via email

Uh oh!

ogrisel left a comment

Choose a reason for hiding this comment

Uh oh!

ogrisel Apr 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogrisel Apr 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogrisel Apr 17, 2019

Choose a reason for hiding this comment

Uh oh!

ogrisel Apr 17, 2019

Choose a reason for hiding this comment

Uh oh!

bharatr21 commented Apr 22, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ogrisel Apr 17, 2019 •

edited

Loading

ogrisel Apr 17, 2019 •

edited

Loading