Skip to content

[MRG+1] Fix #9676: Section level wrong in user guide #9679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 4, 2017

Conversation

shaz13
Copy link
Contributor

@shaz13 shaz13 commented Sep 3, 2017

Fixes #9676

The Section level is now reordered as suggested in the issue. Thanks @GaelVaroquaux !

 3.1.3 and 3.1.4 changed to 3.1.2.1 and 3.1.2.2
@shaz13
Copy link
Contributor Author

shaz13 commented Sep 3, 2017

Visual PR changes -

screen shot 2017-09-03 at 7 30 11 pm

@jnothman
Copy link
Member

jnothman commented Sep 3, 2017

Firstly, I don't think you should be moving anything.

Secondly, to me it's not this simple. Everything from the current 3.1.3 to 3.1.8 should be within 3.1.2. So every heading in that passage needs to be the next level.

@shaz13
Copy link
Contributor Author

shaz13 commented Sep 3, 2017

Hi @jnothman, thanks for your review. I pushed a commit. Made all the headings from 3.1.3 - 3.1.8 under 3.1.2.

PTAL. Thanks!

@GaelVaroquaux GaelVaroquaux changed the title Fix #9676: Section level wrong in user guide [MRG+1] Fix #9676: Section level wrong in user guide Sep 3, 2017
@GaelVaroquaux
Copy link
Member

LGTM. +1 for merge.

@lesteve
Copy link
Member

lesteve commented Sep 4, 2017

Here is an excerpt of the htmldiff:

snapshot

I am wondering whether "A note on shuffling" and "Cross validation and model selection" should not be on the same level as "Cross validation iterators"

@jnothman
Copy link
Member

jnothman commented Sep 4, 2017 via email

@shaz13
Copy link
Contributor Author

shaz13 commented Sep 4, 2017

Is it good to merge or do I have to unindent - "A note on shuffling" and "Cross validation and model selection"?

@jnothman
Copy link
Member

jnothman commented Sep 4, 2017

I think @lesteve may be right, that we don't lose anything by making Cross Validation Iterators a top level heading here...

@lesteve
Copy link
Member

lesteve commented Sep 4, 2017

I pushed the change I had in mind, merging this one, thanks a lot @shaz13!

@lesteve lesteve merged commit 95d0ae6 into scikit-learn:master Sep 4, 2017
@jnothman
Copy link
Member

jnothman commented Sep 4, 2017 via email

@lesteve
Copy link
Member

lesteve commented Sep 4, 2017

In my head I did ;-). Basically I wanted "A note on shuffling" and "Cross validation and model selection" to have the same level as "Cross Validation iterators".

Seems fine AFAICT from:
https://github.com/scikit-learn/scikit-learn/blob/master/doc/modules/cross_validation.rst#cross-validation-iterators

@shaz13 shaz13 deleted the Cross-val-doc-fix branch September 4, 2017 14:52
massich pushed a commit to massich/scikit-learn that referenced this pull request Sep 15, 2017
amueller pushed a commit to jnothman/scikit-learn that referenced this pull request Oct 20, 2017
yarikoptic added a commit to yarikoptic/scikit-learn that referenced this pull request Oct 24, 2017
* tag '0.19.1': (117 commits)
  TST Improve SelectFromModel tests (scikit-learn#9733)
  Name in what's new
  [MRG+1] Raise error when SparseSeries is passed into classification metrics (scikit-learn#7373)
  Fix LogisticRegressionCV default solver value in docstring (scikit-learn#9962)
  [MRG+1] DOC fix sign in GBRT mathematical formulation (scikit-learn#9885)
  [MRG+1] DOC fix sign in GBRT mathematical formulation (scikit-learn#9885)
  DOC fix a typo (scikit-learn#9892)
  [MRG+1] Ledoit-Wolf behavior explanation (scikit-learn#9500)
  [MRG+1] Fix typos in documentation (scikit-learn#9878)
  DOC: Use setattr(self, ...) instead of self.setattr(...) (scikit-learn#9866)
  DOC Removed a duplicate occurrence of a word in 'sklearn.neighbors.KNeighborsRegressor' docs (scikit-learn#9862)
  FIX docstring of negative_outlier_factor_ in LOF (scikit-learn#9809)
  [MRG+1] Fix scikit-learn#9743: Adding parameter information to docstring. (scikit-learn#9757)
  DOC: fix docstring of Imputer.fit (scikit-learn#9769)
  various minor spelling tweaks (scikit-learn#9783)
  MAINT comment on apparent inconsistency
  [MRG+1] DOC fix headers level in cross_validation.rst (scikit-learn#9679)
  Fix mailmap format (scikit-learn#9620)
  DOC Fix typos (scikit-learn#9577)
  Typo (scikit-learn#9571)
  ...
yarikoptic added a commit to yarikoptic/scikit-learn that referenced this pull request Oct 24, 2017
* releases: (117 commits)
  TST Improve SelectFromModel tests (scikit-learn#9733)
  Name in what's new
  [MRG+1] Raise error when SparseSeries is passed into classification metrics (scikit-learn#7373)
  Fix LogisticRegressionCV default solver value in docstring (scikit-learn#9962)
  [MRG+1] DOC fix sign in GBRT mathematical formulation (scikit-learn#9885)
  [MRG+1] DOC fix sign in GBRT mathematical formulation (scikit-learn#9885)
  DOC fix a typo (scikit-learn#9892)
  [MRG+1] Ledoit-Wolf behavior explanation (scikit-learn#9500)
  [MRG+1] Fix typos in documentation (scikit-learn#9878)
  DOC: Use setattr(self, ...) instead of self.setattr(...) (scikit-learn#9866)
  DOC Removed a duplicate occurrence of a word in 'sklearn.neighbors.KNeighborsRegressor' docs (scikit-learn#9862)
  FIX docstring of negative_outlier_factor_ in LOF (scikit-learn#9809)
  [MRG+1] Fix scikit-learn#9743: Adding parameter information to docstring. (scikit-learn#9757)
  DOC: fix docstring of Imputer.fit (scikit-learn#9769)
  various minor spelling tweaks (scikit-learn#9783)
  MAINT comment on apparent inconsistency
  [MRG+1] DOC fix headers level in cross_validation.rst (scikit-learn#9679)
  Fix mailmap format (scikit-learn#9620)
  DOC Fix typos (scikit-learn#9577)
  Typo (scikit-learn#9571)
  ...
yarikoptic added a commit to yarikoptic/scikit-learn that referenced this pull request Oct 24, 2017
* dfsg: (117 commits)
  TST Improve SelectFromModel tests (scikit-learn#9733)
  Name in what's new
  [MRG+1] Raise error when SparseSeries is passed into classification metrics (scikit-learn#7373)
  Fix LogisticRegressionCV default solver value in docstring (scikit-learn#9962)
  [MRG+1] DOC fix sign in GBRT mathematical formulation (scikit-learn#9885)
  [MRG+1] DOC fix sign in GBRT mathematical formulation (scikit-learn#9885)
  DOC fix a typo (scikit-learn#9892)
  [MRG+1] Ledoit-Wolf behavior explanation (scikit-learn#9500)
  [MRG+1] Fix typos in documentation (scikit-learn#9878)
  DOC: Use setattr(self, ...) instead of self.setattr(...) (scikit-learn#9866)
  DOC Removed a duplicate occurrence of a word in 'sklearn.neighbors.KNeighborsRegressor' docs (scikit-learn#9862)
  FIX docstring of negative_outlier_factor_ in LOF (scikit-learn#9809)
  [MRG+1] Fix scikit-learn#9743: Adding parameter information to docstring. (scikit-learn#9757)
  DOC: fix docstring of Imputer.fit (scikit-learn#9769)
  various minor spelling tweaks (scikit-learn#9783)
  MAINT comment on apparent inconsistency
  [MRG+1] DOC fix headers level in cross_validation.rst (scikit-learn#9679)
  Fix mailmap format (scikit-learn#9620)
  DOC Fix typos (scikit-learn#9577)
  Typo (scikit-learn#9571)
  ...
maskani-moh pushed a commit to maskani-moh/scikit-learn that referenced this pull request Nov 15, 2017
jwjohnson314 pushed a commit to jwjohnson314/scikit-learn that referenced this pull request Dec 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants