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

Update doc string for pred_contrib #2116

Merged
merged 7 commits into from Apr 19, 2019
Merged

Conversation

slundberg
Copy link
Contributor

See comments at the end of #1969

Copy link
Collaborator

@StrikerRUS StrikerRUS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@slundberg Can you please expand your update to other places too?
Here they are:
https://github.com/Microsoft/LightGBM/blob/beb35d567de899b140bd61e174ef3b9ef5fd0769/python-package/lightgbm/sklearn.py#L583-L587
https://github.com/Microsoft/LightGBM/blob/beb35d567de899b140bd61e174ef3b9ef5fd0769/python-package/lightgbm/sklearn.py#L788-L790
https://github.com/Microsoft/LightGBM/blob/beb35d567de899b140bd61e174ef3b9ef5fd0769/include/LightGBM/config.h#L590
Update in config.h should be performed in the following way: start a new line (591) with new note // desc = **Note**: unlike the shap package ... and then run python helpers/parameter_generator.py to update parameters documentation in rst format. Thanks!

python-package/lightgbm/basic.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@StrikerRUS StrikerRUS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@slundberg Thanks a lot!
Please remove whitespaces at lines' end and run python helpers/parameter_generator.py to update docs in rst format, which will make CI tests happy, which, in turn, will let me merge this PR.

image

I'm sorry for this, as I'm sure that you have a lot of work besides updating docstrings in third party packages. :-)

@slundberg
Copy link
Contributor Author

No problem. Should be good to go now :)

@StrikerRUS
Copy link
Collaborator

@slundberg Oops! One more whitespace, which makes merge button disabled for me:

image

@slundberg
Copy link
Contributor Author

My bad. Thought I had removed that one!

@StrikerRUS StrikerRUS merged commit 89f2021 into microsoft:master Apr 19, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Mar 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants