Skip to content

[MRG] Remove unnecessary backticks in docs #8432

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Feb 22, 2017
Merged

[MRG] Remove unnecessary backticks in docs #8432

merged 5 commits into from
Feb 22, 2017

Conversation

tzano
Copy link
Contributor

@tzano tzano commented Feb 22, 2017 •
edited by lesteve
Loading

Reference Issue

Fixes #8430

What does this implement/fix? Explain your changes.

Removed unnecessary backticks in docs from:

jnothman
jnothman reviewed Feb 22, 2017
View reviewed changes
sklearn/feature_selection/from_model.py Outdated
@@ -113,12 +113,12 @@ class SelectFromModel(BaseEstimator, SelectorMixin):

Attributes
----------
`estimator_`: an estimator
estimator_: an estimator
Copy link
Member

Choose a reason for hiding this comment

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

require space before colon

sklearn/feature_selection/from_model.py Outdated
The base estimator from which the transformer is built.
This is stored only when a non-fitted estimator is passed to the
``SelectFromModel``, i.e when prefit is False.

`threshold_`: float
threshold_: float
Copy link
Member

Choose a reason for hiding this comment

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

require space before colon

@codecov
Copy link

codecov bot commented Feb 22, 2017 •
edited
Loading

Codecov Report

Merging #8432 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #8432   +/-   ##
=======================================
  Coverage   94.75%   94.75%           
=======================================
  Files         342      342           
  Lines       60902    60902           
=======================================
  Hits        57708    57708           
  Misses       3194     3194
Impacted Files Coverage Δ
sklearn/isotonic.py 93.85% <ø> (ø) ✅
sklearn/covariance/shrunk_covariance_.py 92.12% <ø> (ø) ✅
sklearn/metrics/pairwise.py 97.21% <ø> (ø) ✅
sklearn/ensemble/gradient_boosting.py 95.79% <ø> (ø) ✅
sklearn/feature_selection/from_model.py 94.02% <ø> (ø) ✅
sklearn/metrics/cluster/unsupervised.py 100% <ø> (ø) ✅

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update daeba62...d769452. Read the comment docs.

@lesteve
Copy link
Member

lesteve commented Feb 22, 2017

@tzano I have edited your PR description, please use "Fixes #issueNumber" this way the associated issue gets closed automatically when the PR is merged.

@lesteve
Copy link
Member

lesteve commented Feb 22, 2017

Rerunning the same hacky git grep command it seems like you missed a few:

❯ git grep -P '`.+`\s*:\s*\w+' -- '*.py'
examples/plot_johnson_lindenstrauss_bound.py:.. _`Johnson-Lindenstrauss lemma`: https://en.wikipedia.org/wiki/Johnson%E2%80%93Lindens
sklearn/cluster/birch.py:        - `None` : the final clustering step is not performed and the
sklearn/cluster/birch.py:        - `int` : the model fit is :class:`AgglomerativeClustering` with
sklearn/datasets/lfw.py:      .. _`README.txt`: http://vis-www.cs.umass.edu/lfw/README.txt
sklearn/decomposition/pca.py:            `n_components`: if the input data is larger than 500x500 and the
sklearn/ensemble/gradient_boosting.py:    `init` : BaseEstimator
sklearn/linear_model/ransac.py:         * `fit(X, y)`: Fit model to given training data and target values.
sklearn/linear_model/ransac.py:         * `score(X, y)`: Returns the mean accuracy on the given test data,
sklearn/metrics/cluster/unsupervised.py:    `**kwds` : optional keyword parameters
sklearn/metrics/cluster/unsupervised.py:    `**kwds` : optional keyword parameters
sklearn/neighbors/approximate.py:    The cosine distance is defined as ``1 - cosine_similarity``: the lowest
sklearn/pipeline.py:        This also works where final estimator is ``None``: all prior

At least, gradient_boosting, ransac and cluster/unsupervised seems like they need fixing.

@tzano
Copy link
Contributor Author

tzano commented Feb 22, 2017

Thanks @lesteve. I have pushed the changes.

lesteve
lesteve reviewed Feb 22, 2017
View reviewed changes
sklearn/linear_model/ransac.py Outdated
@@ -68,8 +68,8 @@ class RANSACRegressor(BaseEstimator, MetaEstimatorMixin, RegressorMixin):
base_estimator : object, optional
Base estimator object which implements the following methods:

* `fit(X, y)`: Fit model to given training data and target values.
* `score(X, y)`: Returns the mean accuracy on the given test data,
* fit(X, y) : Fit model to given training data and target values.
Copy link
Member

Choose a reason for hiding this comment

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

Sorry I did not read the git grep output correctly. Leave this file as it was.

@lesteve
Copy link
Member

lesteve commented Feb 22, 2017

LGTM, by the way [WIP] should only be used when you feel your PR is not ready for review, please remember to set it to [MRG] when you feel it has matured enough to receive detailed feed-back. Look at https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md for more details.

@lesteve lesteve changed the title [WIP] Remove unnecessary backticks in docs [MRG] Remove unnecessary backticks in docs Feb 22, 2017
@lesteve lesteve merged commit 6f771d5 into scikit-learn:master Feb 22, 2017
@lesteve
Copy link
Member

lesteve commented Feb 22, 2017

Merged, thanks a lot!

sergeyf pushed a commit to sergeyf/scikit-learn that referenced this pull request Feb 28, 2017
@tzano @sergeyf
[MRG] Remove unnecessary backticks around parameter name in docstrings (
f10ac95 
scikit-learn#8432)
@Przemo10 Przemo10 mentioned this pull request Mar 17, 2017
Closed
Sundrique pushed a commit to Sundrique/scikit-learn that referenced this pull request Jun 14, 2017
@tzano @Sundrique
[MRG] Remove unnecessary backticks around parameter name in docstrings (
b6c948c 
scikit-learn#8432)
NelleV pushed a commit to NelleV/scikit-learn that referenced this pull request Aug 11, 2017
@tzano @NelleV
[MRG] Remove unnecessary backticks around parameter name in docstrings (
8ebc14c 
scikit-learn#8432)
paulha pushed a commit to paulha/scikit-learn that referenced this pull request Aug 19, 2017
@tzano @paulha
[MRG] Remove unnecessary backticks around parameter name in docstrings (
9f25429 
scikit-learn#8432)
maskani-moh pushed a commit to maskani-moh/scikit-learn that referenced this pull request Nov 15, 2017
@tzano @maskani-moh
[MRG] Remove unnecessary backticks around parameter name in docstrings (
5519d12 
scikit-learn#8432)
lemonlaug pushed a commit to lemonlaug/scikit-learn that referenced this pull request Jan 6, 2021
@tzano
[MRG] Remove unnecessary backticks around parameter name in docstrings (
a4341bc 
scikit-learn#8432)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jnothman jnothman jnothman left review comments

@lesteve lesteve lesteve left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove backticks in SelectFromModel attributes
3 participants
@tzano @lesteve @jnothman