diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 68c09bcb..8efbf6e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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**, diff --git a/docs/api/connection.rst b/docs/api/connection.rst index fc44ff8b..2699655a 100644 --- a/docs/api/connection.rst +++ b/docs/api/connection.rst @@ -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** diff --git a/docs/api/printer.rst b/docs/api/printer.rst index 1184965f..d20bcf46 100644 --- a/docs/api/printer.rst +++ b/docs/api/printer.rst @@ -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 ` will return a successful result. .. note:: diff --git a/docs/conf.py b/docs/conf.py index 21559ff5..74799d52 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/configuration/config_yaml.rst b/docs/configuration/config_yaml.rst index e182e6bb..7852b34b 100644 --- a/docs/configuration/config_yaml.rst +++ b/docs/configuration/config_yaml.rst @@ -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 diff --git a/docs/configuration/yaml.rst b/docs/configuration/yaml.rst index 3c669656..b7b4e56a 100644 --- a/docs/configuration/yaml.rst +++ b/docs/configuration/yaml.rst @@ -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. \ No newline at end of file diff --git a/docs/plugins/gettingstarted.rst b/docs/plugins/gettingstarted.rst index 3c6c60d2..16052761 100644 --- a/docs/plugins/gettingstarted.rst +++ b/docs/plugins/gettingstarted.rst @@ -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. diff --git a/docs/plugins/hooks.rst b/docs/plugins/hooks.rst index 36a6e2c3..eaad56e4 100644 --- a/docs/plugins/hooks.rst +++ b/docs/plugins/hooks.rst @@ -107,12 +107,12 @@ This describes actually four hooks: ``phase`` will always match the ```` 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: "_