From 60dbde834bf47b68b4e8f61286b1ab43a318c7cc Mon Sep 17 00:00:00 2001 From: Robin Dunn Date: Tue, 8 Aug 2017 19:08:41 -0700 Subject: [PATCH] '&' --> 'and' and some other text tweaks --- docs/sphinx/rest_substitutions/overviews/index.rst | 11 ++++++----- setup.py | 7 ++++--- wx/tools/wxget_docs_demo.py | 10 +++++----- 3 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/sphinx/rest_substitutions/overviews/index.rst b/docs/sphinx/rest_substitutions/overviews/index.rst index 751a0252..988166ee 100644 --- a/docs/sphinx/rest_substitutions/overviews/index.rst +++ b/docs/sphinx/rest_substitutions/overviews/index.rst @@ -1,6 +1,6 @@ .. wxPython Phoenix documentation Created: 9-Dec-2011 - Copyright: (c) 2011-2016 by Total Control Software + Copyright: (c) 2011-2017 by Total Control Software License: wxWindows License .. include:: headings.inc @@ -15,16 +15,17 @@ If you are porting your code from Classic wxPython, be sure to read the `Migration Guide `_ to get a better feel for how some things have changed. +You can download a local copy of this documentation using a new utility script +included with wxPython called ``wxdocs``. It will open the local copy of the +documentation in your default browser, downloading it first if needed. There +is also a similar tool called ``wxdemo`` that will download (if needed) +and launch the wxPython demo for you. .. note:: If you wish to help in the documentation effort, the main docstrings guidelines are outlined in the `Docstring Guidelines `_ document. -.. note:: The wxPython Documentation & Demo packages can be fetched, installed - & launched with 2 new utilities, wxdocs and wxdemo respectively - fetching & - installing are only done if necessary, e.g. after a version update. - These both make use of a wxget a, (simplistic, pure wxpython wget), utility. .. raw:: html diff --git a/setup.py b/setup.py index ee39aab1..bad064a2 100644 --- a/setup.py +++ b/setup.py @@ -62,9 +62,10 @@ Archive files containing a copy of the wxPython documentation, the demo and samples, and also a set of MSVC .pdb files for Windows are available `here `_. -The utility tools wxdocs & wxdemo will download the appropIATE files with wxget, -(if necessary), unpack them, (if necessary) & launch the appropriate version of -the respective items. (Documents are launched in the browser & Demo with python). +The utility tools wxdocs and wxdemo will download the appropriate files with wxget, +(if necessary), unpack them, (if necessary) and launch the appropriate version of +the respective items. (Documents are launched in the default browser and demo is started +with python). """.format(version=cfg.VERSION, docs_base=DOCS_BASE) diff --git a/wx/tools/wxget_docs_demo.py b/wx/tools/wxget_docs_demo.py index 73a8a4ce..0ca5d958 100644 --- a/wx/tools/wxget_docs_demo.py +++ b/wx/tools/wxget_docs_demo.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- #---------------------------------------------------------------------- # Name: wx.tools.wxget_docs_demo -# Purpose: wx fetch & launch demo or docs +# Purpose: wx fetch and launch demo or docs # # Author: Steve Barnes # @@ -11,7 +11,7 @@ # Licence: wxWindows license # Tags: phoenix-port, py3-port # -# Module to allow the correct version of the documents &/or demos to be +# Module to allow the correct version of the documents and/or demos to be # launched after, if necessarily being fetched. #---------------------------------------------------------------------- @@ -95,7 +95,7 @@ def get_item(final, url, cache, name, ext): cached = os.path.join(cache, name) cached = os.path.extsep.join([cached, ext]) - print('Looking for cashed', cached) + print('Looking for cached', cached) if not os.path.exists(cached): # No cached copy yes_no = wx.MessageBox( "\n".join( @@ -145,7 +145,7 @@ def docs_main(args=sys.argv): print("Show Docs at:", location) webbrowser.open(location_url) else: - result = 'Unable to find & show the wxPython Documentation!' + result = 'Unable to find and show the wxPython Documentation!' report_error(result) done(result) @@ -164,7 +164,7 @@ def demo_main(args=sys.argv): #subprocess.check_call(cmds) # Use instead for debug print("Demo starting as PID %s - may take a few seconds!" % pid) else: - result = 'Unable to find & start the wxPython Demo!' + result = 'Unable to find and start the wxPython Demo!' report_error(result) done(result)