Xqt has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/683950 )
Change subject: [doc] Update documentation ......................................................................
[doc] Update documentation
* depedency --> dependency * github --> GitHub * pypi --> PyPI ** See https://pypi.org/ * circleci --> CircleCI ** See https://circleci.com/docs/ * appveyor --> AppVeyor ** See https://www.appveyor.com/docs/ * travis --> Travis ** See https://travis-ci.org/ * svn --> SVN ** See https://en.wikipedia.org/wiki/Apache_Subversion * git --> Git ** See https://en.wikipedia.org/wiki/Git
Change-Id: I7273855254de11403c8be73eb6d910f3a2ea5d8f --- M .travis.yml M dev-requirements.txt M pywikibot/pagegenerators.py M pywikibot/version.py M setup.py M tests/README.rst 6 files changed, 24 insertions(+), 24 deletions(-)
Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved
diff --git a/.travis.yml b/.travis.yml index f63277d..f470f92 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,4 @@ -# See tests/README.rst for instructions for using travis with developer builds. +# See tests/README.rst for instructions for using Travis with developer builds.
language: python
diff --git a/dev-requirements.txt b/dev-requirements.txt index 974c2dd..7323cec 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -8,7 +8,7 @@ pytest-attrib>=0.1.3 # pytest-httpbin needs httpbin needs werkzeug >= 0.14.1 # Python 3.8 needs werkzeug >= 0.15.5 -# github vulnerable depedency suggests werkzeug >= 0.15.3 +# GitHub vulnerable dependency suggests werkzeug >= 0.15.3 werkzeug>=0.15.5 pytest-httpbin
diff --git a/pywikibot/pagegenerators.py b/pywikibot/pagegenerators.py index 03f8f55..0d2314d 100644 --- a/pywikibot/pagegenerators.py +++ b/pywikibot/pagegenerators.py @@ -2591,8 +2591,8 @@
L{https://pypi.org/project/google%7D
- This package has been available since 2010, hosted on github - since 2012, and provided by pypi since 2013. + This package has been available since 2010, hosted on GitHub + since 2012, and provided by PyPI since 2013.
As there are concerns about Google's Terms of Service, this generator prints a warning for each query. diff --git a/pywikibot/version.py b/pywikibot/version.py index d62f977..96b1d03 100644 --- a/pywikibot/version.py +++ b/pywikibot/version.py @@ -111,7 +111,7 @@ .format(exceptions), UserWarning) exceptions = None
- # git and svn can silently fail, as it may be a nightly. + # Git and SVN can silently fail, as it may be a nightly. if exceptions: pywikibot.debug('version algorithm exceptions:\n{!r}' .format(exceptions), _logger) diff --git a/setup.py b/setup.py index e521b49..4abb54d 100644 --- a/setup.py +++ b/setup.py @@ -121,7 +121,7 @@ # to set the console font and copy and paste, achieved using pywinauto # which depends on pywin32. # These tests may be disabled because pywin32 depends on VC++, is time -# consuming to build, and the console window can't be accessed during appveyor +# consuming to build, and the console window can't be accessed during AppVeyor # builds. if os.name == 'nt' and os.environ.get('PYSETUP_TEST_NO_UI', '0') != '1': test_deps += [ diff --git a/tests/README.rst b/tests/README.rst index 3e2a280..73a07fd 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -95,21 +95,21 @@ Travis CI =========
-After changes are published into a github repository, tests may be run on +After changes are published into a GitHub repository, tests may be run on travis-ci.org according to the configuration in .travis.yml .
When changes are merged into the main repository, they are replicated to -https://github.com/wikimedia/pywikibot , and travis tests are run and +https://github.com/wikimedia/pywikibot , and Travis tests are run and published at https://travis-ci.org/wikimedia/pywikibot/builds . These tests use the Wikimedia global (SUL) account 'Pywikibot-test', which has a password securely stored in .travis.yml file. See section env:global:secure.
-Anyone can run these tests on travis-ci.org using their own github account, with +Anyone can run these tests on travis-ci.org using their own GitHub account, with code changes that have not been merged into the main repository. To do this:
-1. create a github and travis-ci account -2. fork the main github repository https://github.com/wikimedia/pywikibot -3. enable builds from the travis profile page: https://travis-ci.org/profile +1. create a GitHub and travis-ci account +2. fork the main GitHub repository https://github.com/wikimedia/pywikibot +3. enable builds from the Travis profile page: https://travis-ci.org/profile 4. push changes into the forked git repository 5. watch the build at https://travis-ci.org/<username>/pywikibot/builds
@@ -118,7 +118,7 @@ are skipped if the travis-ci build environment does not have a password.
To enable 'user' tests on travis-ci builds for a different repository, add -a username and password to travis: +a username and password to Travis:
1. Go to https://travis-ci.org/<username>/pywikibot/settings 2. Add a new variable named PYWIKIBOT_USERNAME and a value of a valid @@ -138,33 +138,33 @@ `travis-ci #4350 https://github.com/travis-ci/travis-ci/issues/4350`_).
It is strongly recommended that an untrusted bot account is created for -travis tests, using a password that is not shared with trusted accounts. +Travis tests, using a password that is not shared with trusted accounts.
-Appveyor CI +AppVeyor CI ===========
-After changes are published into a github repository, tests may be run on +After changes are published into a GitHub repository, tests may be run on a Microsoft Windows box provided by ci.appveyor.com according to the configuration in .appveyor.yml file. To do this:
-1. create a github and appveyor account -2. fork the main github repository +1. create a GitHub and AppVeyor account +2. fork the main GitHub repository 3. create a project in ci.appveyor.com 4. go to https://ci.appveyor.com/project/<username>/pywikibot/settings and enter the custom configuration .yml filename: .appveyor.yml 5. push changes into the forked git repository 6. watch the build at https://ci.appveyor.com/<username>/pywikibot/history
-The 'user' tests are not yet enabled on appveyor builds. +The 'user' tests are not yet enabled on AppVeyor builds.
CircleCI ========
-After changes are published into a github repository, tests may be run on +After changes are published into a GitHub repository, tests may be run on CircleCI Ubuntu servers.
-1. create a github and circleci account -2. fork the main github repository +1. create a GitHub and CircleCI account +2. fork the main GitHub repository 3. create a project in circleci.com 4. go to https://circleci.com/gh/<username>/pywikibot/edit#env-vars and add the following variables: @@ -190,7 +190,7 @@ tests **may** actually perform a write operation.
These 'edit failure' tests are disabled by default. On Travis they are enabled -by default on builds by any other github account except 'wikimedia'. +by default on builds by any other GitHub account except 'wikimedia'.
To disable 'edit failure' tests, set PYWIKIBOT_TEST_WRITE_FAIL=0
@@ -199,7 +199,7 @@ should always only write to 'test' wikis.
These 'write' tests are disabled by default, and currently can not be -run on travis or appveyor as they require interaction using a terminal. Also +run on Travis or AppVeyor as they require interaction using a terminal. Also enabling them won't enable 'edit failure' tests.
To enable 'write' tests, set PYWIKIBOT_TEST_WRITE=1