Typo and spelling fixes

Fixes various spelling issues and typos.
This commit is contained in:
bwgan 2016-01-28 18:59:38 +00:00
parent dedadbc9ac
commit f8c0df4e78
19 changed files with 50 additions and 50 deletions

View file

@ -233,7 +233,7 @@ See [How to open the Javascript Console in different browsers](https://webmaster
scenarios you don't normally use, e.g. if you only use access control, test
without and vice versa. If you only test with your printer, test with the
virtual printer and vice versa. State in your pull request how your tested
your changes. Ideally **add unit tests** - OctoPrint severly lacks in that
your changes. Ideally **add unit tests** - OctoPrint severely lacks in that
department, but we are trying to change that, so any new code already covered
with a test suite helps a lot!
6. In your pull request's description, **state what your pull request is doing**,

View file

@ -76,9 +76,9 @@ Issue a connection command
Instructs OctoPrint to disconnect from the printer.
fake_ack
Fakes an acknowledgement message for OctoPrint in case one got lost on the serial line and the communication
Fakes an acknowledgment message for OctoPrint in case one got lost on the serial line and the communication
with the printer since stalled. This should only be used in "emergencies" (e.g. to save prints), the reason
for the lost acknowledgement should always be properly investigated and removed instead of depending on this
for the lost acknowledgment should always be properly investigated and removed instead of depending on this
"symptom solver".
**Example Connect Request**

View file

@ -699,7 +699,7 @@ Issue an SD command
init
Initializes the printer's SD card, making it available for use. This also includes an initial retrieval of the
list of files currently stored on the SD card, so after issueing that command a :ref:`retrieval of the files
list of files currently stored on the SD card, so after issuing that command a :ref:`retrieval of the files
on SD card <sec-api-fileops-retrievelocation>` will return a successful result.
.. note::

View file

@ -111,7 +111,7 @@ if not on_rtd: # only import and set the theme if we're building docs locally
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# a list of built-in themes.
#html_theme = "sphinx_rtd_theme"
# Theme options are theme-specific and customize the look and feel of a theme
@ -139,8 +139,8 @@ if not on_rtd: # only import and set the theme if we're building docs locally
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# relative to this directory. They are copied after the built-in static files,
# so a file named "default.css" will overwrite the built-in "default.css".
html_static_path = ['_static']
def setup(app):
@ -215,7 +215,7 @@ htmlhelp_basename = 'OctoPrintdoc'
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# For "manual" documents, if this is true, then top-level headings are parts,
# not chapters.
#latex_use_parts = False

View file

@ -640,7 +640,7 @@ Use the following settings to configure the server:
# that AJAX requests and download URLs work.
reverseProxy:
# The request header from which to determine the url prefix under which OctoPrint
# The request header from which to determine the URL prefix under which OctoPrint
# is served by the reverse proxy
prefixHeader: X-Script-Name
@ -652,7 +652,7 @@ Use the following settings to configure the server:
# is served by the reverse proxy
hostHeader: X-Forwarded-Host
# Use this option to define an optional url prefix (with a leading /, so absolute to your
# Use this option to define an optional URL prefix (with a leading /, so absolute to your
# server's root) under which to run OctoPrint. This should only be needed if you want to run
# OctoPrint behind a reverse proxy under a different root endpoint than `/` and can't configure
# said reverse proxy to send a prefix HTTP header (X-Script-Name by default, see above) with

View file

@ -202,7 +202,7 @@ Finally, ``the_end`` is just a boolean, since an unquoted ``yes`` evaluates as a
Don't get confused by the list "dividing" one part of the dictionary under ``general`` from the other -- your mind is
just playing a trick on you due to the list's dashes ``-`` being on the same levels as the dictionary keys. You could
also just add two more spaces to your identation and write that part like this, which makes the structure a bit
also just add two more spaces to your indentation and write that part like this, which makes the structure a bit
clearer (whitespace again made visible to help track indentation):
.. code-block-ext:: yaml
@ -219,6 +219,6 @@ clearer (whitespace again made visible to help track indentation):
# ...
Just make sure you follow a consistent way of indenting your files -- YAML is not as strict as Python when it comes to
differing identation variants within the same file (as long as it's still valid), but consistency will help you as
differing indentation variants within the same file (as long as it's still valid), but consistency will help you as
a lot as a human. Ideally you'll use a text editor which highlights white space characters for you (most editors can
be configured this way), this will help tremendously when editing whitespace sensitive syntax such as YAML.

View file

@ -993,7 +993,7 @@ stop it from doing that at the start of this section, we should switch this back
stylesheet: css
# [...]
Just out of curiousity, restart, shift-reload and take a final look at the ``head``:
Just out of curiosity, restart, shift-reload and take a final look at the ``head``:
.. code-block:: html
:linenos:
@ -1015,7 +1015,7 @@ Way more compact, isn't it?
CSS files instead of any non-existing LESS files. So you don't really *have* to use LESS if you don't want, but
as soon as you need it just switch over.
The same thing works the other way around too btw. If your plugin only provides LESS files, OctoPrint will link to
The same thing works the other way around too by the way. If your plugin only provides LESS files, OctoPrint will link to
those, lessjs will take care of the compilation. Please keep in mind though that also providing CSS files is the
cleaner way.

View file

@ -107,12 +107,12 @@ This describes actually four hooks:
``phase`` will always match the ``<phase>`` part of the implemented hook (e.g. ``octoprint.comm.protocol.gcode.queued``
handlers will always be called with ``phase`` set to ``queued``). This parameter is provided so that plugins may
utilize the same hook for mulitple phases if required.
utilize the same hook for multiple phases if required.
Handlers are expected to return one of the following result variants:
* ``None``: Don't change anything. Note that Python functions will also automatically return ``None`` if
an empty ``return`` statement is used or just nothing is returned explicitely from the handler. Hence, the following
an empty ``return`` statement is used or just nothing is returned explicitly from the handler. Hence, the following
examples are all falling into this category:
.. code-block:: python
@ -484,13 +484,13 @@ octoprint.ui.web.templatetypes
* - **Key**
- **Description**
* - div
- Function that returns the id of the container for template content if not explicitely provided by the template
- Function that returns the id of the container for template content if not explicitly provided by the template
config, input parameter is the name of the plugin providing the currently processed template config. If not
provided this defaults to a lambda function of the form ``lambda x: "<plugin identifier>_<template type>_plugin_" + x``
with ``plugin identifier`` being the identifier of the plugin providing the additional template type.
* - template
- Function that returns the default template filename for a template type to attempt to include in case no
template name is explicitly provided by the template config, input parameter is the name of the plugin provifing
template name is explicitly provided by the template config, input parameter is the name of the plugin providing
the current processed template config. If not provided this defaults to a lambda function of the form
``lambda x: x + "_plugin_<plugin identifier>_<template type>.jinja2"`` with ``plugin identifier`` being the
identifier of the plugin providing the additional template type.
@ -541,6 +541,6 @@ octoprint.ui.web.templatetypes
:param dict template_rules: read-only dictionary of currently configured template rules
:param dict template_sorting: read-only dictionary of currentl configured template sorting specifications
:param dict template_sorting: read-only dictionary of currently configured template sorting specifications
:return: a list of 3-tuples (template type, rule, sorting spec)
:rtype: list

View file

@ -48,9 +48,9 @@ Dependencies
------------
OctoPrint will try to inject all viewmodel dependencies requested by your viewmodel. In order to do this it will
perform multiple passes iterating over all registered viewmodels and collecting the necessary depedencies prior to
construction. Circular depedencies (A dependens on B, B on C, C on A) naturally cannot be resolved and will cause an
error to be logged to the Javascript console.
perform multiple passes iterating over all registered viewmodels and collecting the necessary dependencies prior to
construction. Circular dependencies (A depends on B, B on C, C on A) naturally cannot be resolved and will cause an
error to be logged to the JavaScript console.
OctoPrint's core currently comes with the following viewmodels that your plugin can request for injection:
@ -76,7 +76,7 @@ navigationViewModel
printerProfilesViewModel
Viewmodel for the printer profiles settings dialog.
printerStateViewModel
Viewmodel for the current printer state, very intersting for plugins that need
Viewmodel for the current printer state, very interesting for plugins that need
to know information about the current print job, if the printer is connected, operational etc.
settingsViewModel
Viewmodel for the settings dialog, also holds all settings to be used by other viewmodels, hence
@ -219,6 +219,6 @@ on your viewmodel, taking a list of all bound viewmodels:
`OctoPrint's core viewmodels <https://github.com/foosel/OctoPrint/tree/devel/src/octoprint/static/js/app/viewmodels>`_
OctoPrint's own viewmodels use the same mechanisms for interacting with each other and the web application as
plugins. Their sourcecode is therefore a good point of reference on how to achieve certain things.
plugins. Their source code is therefore a good point of reference on how to achieve certain things.
`KnockoutJS documentation <http://knockoutjs.com/documentation/introduction.html>`_
OctoPrint makes heavy use of KnockoutJS for building up its web app.

View file

@ -109,7 +109,7 @@ class PygmentsBridgeExt(object):
return self._bridge.highlight_block(source, lang, opts=opts, warn=warn, force=force, **kwargs)
# We are still here => we need to basically do everything the parent implementation does (and does so in a very
# unextensible way...), but inject the whitespace filter into the used lexer just before the highlighting run
# inextensible way...), but inject the whitespace filter into the used lexer just before the highlighting run
# and remove it afterwards so the lexer can be safely reused.
#
# For this we define a context manager that will allow us to wrap a lexer and modify its filters on the fly to

View file

@ -14,7 +14,7 @@ class Daemon:
def __init__(self, pidfile): self.pidfile = pidfile
def daemonize(self):
"""Deamonize class. UNIX double fork mechanism."""
"""Daemonize class. UNIX double fork mechanism."""
try:
pid = os.fork()

View file

@ -156,11 +156,11 @@ class StorageInterface(object):
* ``model``: adds a link to a model from which the file was created/sliced, expected additional data is the ``name``
and optionally the ``hash`` of the file to link to. If the link can be resolved against another file on the
current ``path``, not only will it be added to the links of ``name`` but a reverse link of type ``machinecode``
refering to ``name`` and its hash will also be added to the linked ``model`` file
referring to ``name`` and its hash will also be added to the linked ``model`` file
* ``machinecode``: adds a link to a file containing machine code created from the current file (model), expected
additional data is the ``name`` and optionally the ``hash`` of the file to link to. If the link can be resolved
against another file on the current ``path``, not only will it be added to the links of ``name`` but a reverse
link of type ``model`` refering to ``name`` and its hash will also be added to the linked ``model`` file.
link of type ``model`` referring to ``name`` and its hash will also be added to the linked ``model`` file.
* ``web``: adds a location on the web associated with this file (e.g. a website where to download a model),
expected additional data is a ``href`` attribute holding the website's URL and optionally a ``retrieved``
attribute describing when the content was retrieved

View file

@ -1045,7 +1045,7 @@ class PluginManager(object):
def get_filtered_implementations(self, f, *types):
"""
Get all mixin implementation that implementat *all* of the provided ``types`` and match the provided filter `f`.
Get all mixin implementations that implement *all* of the provided ``types`` and match the provided filter `f`.
Arguments:
f (callable): A filter function returning True for implementations to return and False for those to exclude.

View file

@ -143,7 +143,7 @@ class ShutdownPlugin(OctoPrintPlugin):
class AssetPlugin(OctoPrintPlugin, RestartNeedingPlugin):
"""
The ``AssetPlugin`` mixin allows plugins to define additional static assets such as Javascript or CSS files to
The ``AssetPlugin`` mixin allows plugins to define additional static assets such as JavaScript or CSS files to
be automatically embedded into the pages delivered by the server to be used within the client sided part of
the plugin.
@ -167,7 +167,7 @@ class AssetPlugin(OctoPrintPlugin, RestartNeedingPlugin):
imported at the appropriate places to be available:
js
Javascript files, such as additional view models
JavaScript files, such as additional view models
css
CSS files with additional styles, will be embedded into delivered pages when not running in LESS mode.
less
@ -251,7 +251,7 @@ class TemplatePlugin(OctoPrintPlugin, ReloadNeedingPlugin):
Generic
Plugins may also inject arbitrary templates into the page of the web interface itself, e.g. in order to
add overlays or dialogs to be called from within the plugin's javascript code.
add overlays or dialogs to be called from within the plugin's JavaScript code.
.. figure:: ../images/template-plugin-types-main.png
:align: center
@ -416,8 +416,8 @@ class TemplatePlugin(OctoPrintPlugin, ReloadNeedingPlugin):
]
This will only include the tab defined in ``myplugin_othertab.jinja2`` though, ``myplugin_tab.jinja2`` will
not be included automatically since the presence of a defintion for the ``tab`` type overrides the automatic
injection of the default template. You'll have to include it explicitely:
not be included automatically since the presence of a definition for the ``tab`` type overrides the automatic
injection of the default template. You'll have to include it explicitly:
.. code-block:: python
@ -1112,7 +1112,7 @@ class SlicerPlugin(OctoPrintPlugin):
path (str): The absolute path to which to save the profile.
profile (SlicingProfile): The profile to save.
allow_overwrite (boolean): Whether to allow to overwrite an existing profile at the indicated path (True,
default) or not (False). If a profile already exists on teh path and this is False an
default) or not (False). If a profile already exists on the path and this is False an
:class:`IOError` should be raised.
overrides (dict): Profile overrides to apply to the ``profile`` before saving it
"""
@ -1158,7 +1158,7 @@ class SlicerPlugin(OctoPrintPlugin):
_analysis
Analysis result of the generated machine code as returned by the slicer itself. This should match the
data structure described for the analysis queue of the matching maching code format, e.g.
data structure described for the analysis queue of the matching machine code format, e.g.
:class:`~octoprint.filemanager.analysis.GcodeAnalysisQueue` for GCODE files.
For jobs that did not finish successfully (but not due to being cancelled!), ``result`` should be a :class:`str`

View file

@ -231,7 +231,7 @@ class PluginManagerPlugin(octoprint.plugin.SimpleApiPlugin,
elif path is not None:
pip_args = ["install", sarge.shell_quote(path)]
else:
raise ValueError("Either url or path must be provided")
raise ValueError("Either URL or path must be provided")
if dependency_links or self._settings.get_boolean(["dependency_links"]):
pip_args.append("--process-dependency-links")
@ -244,7 +244,7 @@ class PluginManagerPlugin(octoprint.plugin.SimpleApiPlugin,
returncode, stdout, stderr = self._call_pip(pip_args)
except:
self._logger.exception("Could not install plugin from %s" % url)
return make_response("Could not install plugin from url, see the log for more details", 500)
return make_response("Could not install plugin from URL, see the log for more details", 500)
else:
if force:
pip_args += ["--ignore-installed", "--force-reinstall", "--no-deps"]
@ -252,7 +252,7 @@ class PluginManagerPlugin(octoprint.plugin.SimpleApiPlugin,
returncode, stdout, stderr = self._call_pip(pip_args)
except:
self._logger.exception("Could not install plugin from %s" % url)
return make_response("Could not install plugin from url, see the log for more details", 500)
return make_response("Could not install plugin from URL, see the log for more details", 500)
try:
result_line = filter(lambda x: x.startswith(success_string) or x.startswith(failure_string), stdout)[-1]

View file

@ -3,8 +3,8 @@
This module defines the interface for communicating with a connected printer.
The communication is in fact divided in two components, the :class:`PrinterInterface` and a deeper lying
communcation layer. However, plugins should only ever need to use the :class:`PrinterInterface` as the
abstracted version of the actual printer communiciation.
communication layer. However, plugins should only ever need to use the :class:`PrinterInterface` as the
abstracted version of the actual printer communication.
.. autofunction:: get_connection_options
@ -28,7 +28,7 @@ from octoprint.settings import settings
def get_connection_options():
"""
Retrieves the available ports, baudrates, prefered port and baudrate for connecting to the printer.
Retrieves the available ports, baudrates, preferred port and baudrate for connecting to the printer.
Returned ``dict`` has the following structure::
@ -99,7 +99,7 @@ class PrinterInterface(object):
def fake_ack(self):
"""
Fakes an acknowledgement for the communication layer. If the communication between OctoPrint and the printer
Fakes an acknowledgment for the communication layer. If the communication between OctoPrint and the printer
gets stuck due to lost "ok" responses from the server due to communication issues, this can be used to get
things going again.
"""
@ -155,7 +155,7 @@ class PrinterInterface(object):
def extrude(self, amount):
"""
Extrude ``amount`` milimeters of material from the tool.
Extrude ``amount`` millimeters of material from the tool.
Arguments:
amount (int, float): The amount of material to extrude in mm
@ -429,7 +429,7 @@ class PrinterCallback(object):
"""
Called when the internal state of the :class:`PrinterInterface` changes, due to changes in the printer state,
temperatures, log lines, job progress etc. Updates via this method are guaranteed to be throttled to a maximum
of 2 calles per second.
of 2 callees per second.
``data`` is a ``dict`` of the following structure::

View file

@ -540,7 +540,7 @@ class Printer(PrinterInterface, comm.MachineComPrintCallback):
def refresh_sd_files(self, blocking=False):
"""
Refreshs the list of file stored on the SD card attached to printer (if available and printer communication
Refreshes the list of file stored on the SD card attached to printer (if available and printer communication
available). Optional blocking parameter allows making the method block (max 10s) until the file list has been
received (and can be accessed via self._comm.getSdFiles()). Defaults to an asynchronous operation.
"""

View file

@ -727,7 +727,7 @@ class CustomHTTP1Connection(tornado.http1connection.HTTP1Connection):
length if available, otherwise returns ``default_max_body_size``.
:param method: method of the request to match against
:param path: path od the request to match against
:param path: path of the request to match against
:return: determine maximum content length to apply to this request, max return 0 for unlimited allowed content
length
"""
@ -763,7 +763,7 @@ class LargeResponseHandler(tornado.web.StaticFileHandler):
Arguments:
path (str): The system path from which to serve files (this will be forwarded to the ``initialize`` method of
:class:``~tornado.web.StaticFileHandler``)
default_filename (str): The default filename to serve if none is explicitely specified and the request references
default_filename (str): The default filename to serve if none is explicitly specified and the request references
a subdirectory of the served path (this will be forwarded to the ``initialize`` method of
:class:``~tornado.web.StaticFileHandler`` as the ``default_filename`` keyword parameter). Defaults to ``None``.
as_attachment (bool): Whether to serve requested files with ``Content-Disposition: attachment`` header (``True``)
@ -846,7 +846,7 @@ class UrlProxyHandler(tornado.web.RequestHandler):
* ``Date``, ``Cache-Control``, ``Expires``, ``ETag``, ``Server``, ``Content-Type`` and ``Location`` will be copied over.
* If ``as_attachment`` is set to True, ``Content-Disposition`` will be set to ``attachment``. If ``basename`` is
set including the attachement's ``filename`` attribute will be set to the base name followed by the extension
set including the attachment's ``filename`` attribute will be set to the base name followed by the extension
guessed based on the MIME type from the ``Content-Type`` header of the response. If no extension can be guessed
no ``filename`` attribute will be set.

View file

@ -46,7 +46,7 @@ def settings(init=False, basedir=None, configfile=None):
(False, default). If this is set to True and the plugin manager has already been initialized, a :class:`ValueError`
will be raised. The same will happen if the plugin manager has not yet been initialized and this is set to
False.
basedir (str): Path of the base directoy for all of OctoPrint's settings, log files, uploads etc. If not set
basedir (str): Path of the base directory for all of OctoPrint's settings, log files, uploads etc. If not set
the default will be used: ``~/.octoprint`` on Linux, ``%APPDATA%/OctoPrint`` on Windows and
``~/Library/Application Support/OctoPrint`` on MacOS.
configfile (str): Path of the configuration file (``config.yaml``) to work on. If not set the default will