From 3c1e23a295d93b39103f7a825d8e5915b6e8df56 Mon Sep 17 00:00:00 2001 From: Andreas Mueller <t3kcit@gmail.com> Date: Fri, 20 Oct 2017 16:39:45 -0400 Subject: [PATCH] [MRG+1] Fix typos in documentation (#9878) * Fix grammatical error in * Correct capitalization of "GitHub" Used command `find . -type f -exec sed -i 's/Github/GitHub/g' {} \;` (h/t: https://stackoverflow.com/a/15402972) # Conflicts: # doc/developers/contributing.rst --- CONTRIBUTING.md | 2 +- doc/faq.rst | 2 +- doc/sphinxext/sphinx_issues.py | 4 ++-- doc/themes/scikit-learn/layout.html | 2 +- sklearn/linear_model/tests/test_bayes.py | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0481acf67f..6f643fc46c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -170,7 +170,7 @@ list or on the GitHub issue). Filing bugs ----------- -We use Github issues to track all bugs and feature requests; feel free to +We use GitHub issues to track all bugs and feature requests; feel free to open an issue if you have found a bug or wish to see a feature implemented. It is recommended to check that your issue complies with the diff --git a/doc/faq.rst b/doc/faq.rst index dcaee6da8b..fea4efa010 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -55,7 +55,7 @@ please make sure to include the full traceback that you obtain when running the reproduction script. For bug reports or feature requests, please make use of the -`issue tracker on Github <https://github.com/scikit-learn/scikit-learn/issues>`_. +`issue tracker on GitHub <https://github.com/scikit-learn/scikit-learn/issues>`_. There is also a `scikit-learn Gitter channel <https://gitter.im/scikit-learn/scikit-learn>`_ where some users and developers diff --git a/doc/sphinxext/sphinx_issues.py b/doc/sphinxext/sphinx_issues.py index f4b8c9346b..c952ca0fea 100644 --- a/doc/sphinxext/sphinx_issues.py +++ b/doc/sphinxext/sphinx_issues.py @@ -33,7 +33,7 @@ __license__ = 'MIT' def user_role(name, rawtext, text, lineno, inliner, options=None, content=None): """Sphinx role for linking to a user profile. Defaults to linking to - Github profiles, but the profile URIS can be configured via the + GitHub profiles, but the profile URIS can be configured via the ``issues_user_uri`` config value. Example: :: @@ -104,7 +104,7 @@ def setup(app): # Format template for issues URI # e.g. 'https://github.com/sloria/marshmallow/issues/{issue} app.add_config_value('issues_uri', default=None, rebuild='html') - # Shortcut for Github, e.g. 'sloria/marshmallow' + # Shortcut for GitHub, e.g. 'sloria/marshmallow' app.add_config_value('issues_github_path', default=None, rebuild='html') # Format template for user profile URI # e.g. 'https://github.com/{user}' diff --git a/doc/themes/scikit-learn/layout.html b/doc/themes/scikit-learn/layout.html index 132c8a2b7a..f616345b05 100644 --- a/doc/themes/scikit-learn/layout.html +++ b/doc/themes/scikit-learn/layout.html @@ -203,7 +203,7 @@ {% endblock %} {% block content %} -<!-- Github "fork me" ribbon --> +<!-- GitHub "fork me" ribbon --> <a href="https://github.com/scikit-learn/scikit-learn"> <img class="fork-me" style="position: absolute; top: 0; right: 0; border: 0;" diff --git a/sklearn/linear_model/tests/test_bayes.py b/sklearn/linear_model/tests/test_bayes.py index 48eeef5e19..d1e02c48dd 100644 --- a/sklearn/linear_model/tests/test_bayes.py +++ b/sklearn/linear_model/tests/test_bayes.py @@ -36,7 +36,7 @@ def test_bayesian_on_diabetes(): def test_bayesian_ridge_parameter(): - # Test correctness of lambda_ and alpha_ parameters (Github issue #8224) + # Test correctness of lambda_ and alpha_ parameters (GitHub issue #8224) X = np.array([[1, 1], [3, 4], [5, 7], [4, 1], [2, 6], [3, 10], [3, 2]]) y = np.array([1, 2, 3, 2, 0, 4, 5]).T -- GitLab