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 + 1] DOC clean up assorted type specifications #10441

Merged
merged 2 commits into from Jan 10, 2018

Conversation

jnothman
Copy link
Member

With thanks to the demo of numpy/numpydoc#150

Minor changes only

@@ -212,8 +212,9 @@ def load_data(module_path, data_file_name):

Parameters
----------
data_file_name : String. Name of csv file to be loaded from
module_path/data/data_file_name. For example 'wine_data.csv'.
data_file_name : String
Copy link
Member

Choose a reason for hiding this comment

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

Are we using String or string or str?

Copy link
Member Author

Choose a reason for hiding this comment

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

Any of the above?

Copy link
Member Author

Choose a reason for hiding this comment

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

Lowercase is much more common though

@@ -658,15 +653,15 @@ class MultinomialNB(BaseDiscreteNB):
class_log_prior_ : array, shape (n_classes, )
Smoothed empirical log probability for each class.

intercept_ : property
intercept_ : array, shape (n_classes, )
Copy link
Member

Choose a reason for hiding this comment

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

(n_classes,) or (n_classes, )

Copy link
Member Author

Choose a reason for hiding this comment

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

Locally consistent

@glemaitre
Copy link
Member

LGTM apart of the 2 comments which are just by curiosity

@glemaitre glemaitre changed the title [MRG] DOC clean up assorted type specifications [MRG + 1] DOC clean up assorted type specifications Jan 10, 2018
@jnothman jnothman merged commit c3bdc0a into scikit-learn:master Jan 10, 2018
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.

None yet

2 participants