Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[MRG + 1] DOC developer quality of life notes #9082

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 3 commits into from
Jul 15, 2017

Conversation

vene
Copy link
Member

@vene vene commented Jun 9, 2017

Reference Issue: none/unk

What does this implement/fix? Explain your changes.

Add a section to the developer's guide where we can gather valuable tools we find or develop to make our lives' easier. Notably, the userscript to navigate to the circleci rendered docs for a PR.

@vene
Copy link
Member Author

vene commented Jun 9, 2017

To reflect the reorganization I moved debugging.rst to tips.rst. Does this mean links will be broken, and should we worry about that?...

@lesteve
Copy link
Member

lesteve commented Jun 9, 2017

I think the circle stuff is already in the doc somewhere.

You should probably add the outdated diff gist while you are at it ;-). https://gist.github.com/lesteve/b4ef29bccd42b354a834

@amueller
Copy link
Member

amueller commented Jun 9, 2017

please mention the PR pull thing from the wiki, and maybe the codecov browser plugin

@vene
Copy link
Member Author

vene commented Jun 9, 2017

@lesteve I couldn't find the circle stuff with git grep, if you can find it could you post a link?

good point about the other additions, I'm simply not familiar enough with them yet, will do

@lesteve
Copy link
Member

lesteve commented Jun 9, 2017

@lesteve I couldn't find the circle stuff with git grep

http://scikit-learn.org/dev/developers/contributing.html#documentation

You may also be asked to show your changes when it’s built. When you create a pull request or make changes in an existing one modifying the docs, CircleCI automatically builds them. Thus, you can easily view your changes in the built artifacts using the following formula:
http://scikit-learn.org/circle?{BUILD_NUMBER}
We attempt to assemble a more precise set of changed files in the documentation at:
http://scikit-learn.org/circle?{BUILD_NUMBER}/_changed.html

@vene vene changed the title [MRG] DOC developer quality of life notes [WIP] DOC developer quality of life notes Jun 9, 2017
@vene
Copy link
Member Author

vene commented Jun 9, 2017

Made the suggested additions and corrections.

@vene vene changed the title [WIP] DOC developer quality of life notes [MRG] DOC developer quality of life notes Jun 9, 2017
@vene
Copy link
Member Author

vene commented Jun 10, 2017

rendered here

@albertcthomas
Copy link
Contributor

thanks for this @vene ! As a new contributor I'm just a bit confused about testing: in the contributing section it is mentioned to use nose and nosetests but you recommend pytests to run unit tests.

@lesteve
Copy link
Member

lesteve commented Jun 15, 2017

Long story short, we used nosetests historically and will be moving to pytest once 0.19 is released.

@amueller
Copy link
Member

lgtm

@amueller amueller changed the title [MRG] DOC developer quality of life notes [MRG + 1] DOC developer quality of life notes Jul 15, 2017
@jnothman jnothman merged commit 22309ea into scikit-learn:master Jul 15, 2017
@jnothman
Copy link
Member

Thanks @vene

jnothman pushed a commit to jnothman/scikit-learn that referenced this pull request Aug 6, 2017
* DOC developer quality of life notes

* rename debugging.rst to tips.rst

* more tips, better internal consistency
dmohns pushed a commit to dmohns/scikit-learn that referenced this pull request Aug 7, 2017
* DOC developer quality of life notes

* rename debugging.rst to tips.rst

* more tips, better internal consistency
dmohns pushed a commit to dmohns/scikit-learn that referenced this pull request Aug 7, 2017
* DOC developer quality of life notes

* rename debugging.rst to tips.rst

* more tips, better internal consistency
NelleV pushed a commit to NelleV/scikit-learn that referenced this pull request Aug 11, 2017
* DOC developer quality of life notes

* rename debugging.rst to tips.rst

* more tips, better internal consistency
paulha pushed a commit to paulha/scikit-learn that referenced this pull request Aug 19, 2017
* DOC developer quality of life notes

* rename debugging.rst to tips.rst

* more tips, better internal consistency
AishwaryaRK pushed a commit to AishwaryaRK/scikit-learn that referenced this pull request Aug 29, 2017
* DOC developer quality of life notes

* rename debugging.rst to tips.rst

* more tips, better internal consistency
maskani-moh pushed a commit to maskani-moh/scikit-learn that referenced this pull request Nov 15, 2017
* DOC developer quality of life notes

* rename debugging.rst to tips.rst

* more tips, better internal consistency
jwjohnson314 pushed a commit to jwjohnson314/scikit-learn that referenced this pull request Dec 18, 2017
* DOC developer quality of life notes

* rename debugging.rst to tips.rst

* more tips, better internal consistency
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.

5 participants