Skip to content
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

[MRG + 2] CI Report likely-affected documentation files #7938

Merged
merged 1 commit into from
Dec 7, 2016

Conversation

jnothman
Copy link
Member

In an attempt to make the changed documentation from a PR still more accessible as rendered, this reports a list of doc pages that were most likely affected by the PR. It is reported in the build logs and at a page http://scikit-learn.org/circle?{BUILD_ID}/_changed.html.

Affected files are presumed to be:

  • doc/...rst -> .html
  • examples/...py -> auto_*.html
  • generated API ref that link as source to files modified by the PR

This last may under-generate in cases of class inheritance (not sure?).

It may over-generate where:

  • multiple classes or functions are defined in the same file
  • the code but not docstring was modified

this over-generation could be fixed by more specific tracking of which source lines correspond to docstrings for which classes/functions... but probably later.

@jnothman
Copy link
Member Author

jnothman commented Nov 25, 2016

I hope to see results at http://scikit-learn.org/circle?7364/_changed.html

@TomDLT
Copy link
Member

TomDLT commented Nov 25, 2016

It seems to work, well done!
Where does The following documentation files may have been changed by ... is supposed to appear?

@jnothman
Copy link
Member Author

jnothman commented Nov 27, 2016 via email

@amueller
Copy link
Member

looks neat. I don't like adding more shell scripts though ... +.5

@jnothman
Copy link
Member Author

jnothman commented Nov 30, 2016 via email

@amueller
Copy link
Member

amueller commented Dec 1, 2016

I wouild ;)

@jnothman
Copy link
Member Author

jnothman commented Dec 2, 2016 via email

@jnothman
Copy link
Member Author

jnothman commented Dec 2, 2016 via email

@amueller amueller changed the title CI Report likely-affected documentation files [MRG + 1] CI Report likely-affected documentation files Dec 6, 2016
@tguillemot
Copy link
Contributor

That will simplify the reviews :). Thanks.
+1 after removing the foo obviously !!!

@amueller amueller changed the title [MRG + 1] CI Report likely-affected documentation files [MRG + 2] CI Report likely-affected documentation files Dec 7, 2016
@jnothman
Copy link
Member Author

jnothman commented Dec 7, 2016

foo removed.

@amueller amueller merged commit d454051 into scikit-learn:master Dec 7, 2016
@jnothman jnothman deleted the affected-doc branch December 8, 2016 00:31
amueller added a commit to amueller/scikit-learn that referenced this pull request Dec 8, 2016
@amueller amueller mentioned this pull request Dec 8, 2016
@jnothman jnothman restored the affected-doc branch December 10, 2016 10:34
sergeyf pushed a commit to sergeyf/scikit-learn that referenced this pull request Feb 28, 2017
sergeyf pushed a commit to sergeyf/scikit-learn that referenced this pull request Feb 28, 2017
Sundrique pushed a commit to Sundrique/scikit-learn that referenced this pull request Jun 14, 2017
Sundrique pushed a commit to Sundrique/scikit-learn that referenced this pull request Jun 14, 2017
NelleV pushed a commit to NelleV/scikit-learn that referenced this pull request Aug 11, 2017
NelleV pushed a commit to NelleV/scikit-learn that referenced this pull request Aug 11, 2017
paulha pushed a commit to paulha/scikit-learn that referenced this pull request Aug 19, 2017
paulha pushed a commit to paulha/scikit-learn that referenced this pull request Aug 19, 2017
maskani-moh pushed a commit to maskani-moh/scikit-learn that referenced this pull request Nov 15, 2017
maskani-moh pushed a commit to maskani-moh/scikit-learn that referenced this pull request Nov 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants