Fix spelling errors or typos

Author: cbm755

changes.txt

@@ -172,7 +172,7 @@ button.cta a {
 :target>h1:first-of-type, span:target~h1:first-of-type {
     background-color: #007aff !important;
     color: #fff !important;
-    padding-top: 40px; /* accomodates header search blocking target */
+    padding-top: 40px; /* accommodates header search blocking target */
     margin-top: -40px;
 }
 
@@ -182,7 +182,7 @@ button.cta a {
 span:target~h2:first-of-type, span:target~h3:first-of-type,
 span:target~h4:first-of-type, span:target~h5:first-of-type, span:target~h6:first-of-type {
     background-color: transparent !important;
-    padding-top: 40px; /* accomodates header search blocking target */
+    padding-top: 40px; /* accommodates header search blocking target */
     margin-top: -40px;
     text-decoration: underline;
 }

docs/_static/custom.css

@@ -15,7 +15,7 @@ There is a parent-child relationship between an annotation and its page. If the
 ================================== ==============================================================
 **Attribute**                      **Short Description**
 ================================== ==============================================================
-:meth:`Annot.delete_responses`     delete all responding annotions
+:meth:`Annot.delete_responses`     delete all responding annotations
 :meth:`Annot.get_file`             get attached file content
 :meth:`Annot.get_oc`               get :data:`xref` of an :data:`OCG` / :data:`OCMD`
 :meth:`Annot.get_pixmap`           image of the annotation as a pixmap

docs/annot.rst

@@ -44,7 +44,7 @@
       document.getElementById("footerDisclaimer").innerHTML = getHeaderAndFooterTranslation("This software is provided AS-IS with no warranty, either express or implied. This software is distributed under license and may not be copied, modified or distributed except as expressly authorized under the terms of that license. Refer to licensing information at <a href='https://www.artifex.com?utm_source=rtd-pymupdf&utm_medium=rtd&utm_content=footer-link'>artifex.com</a> or contact Artifex Software Inc., 39 Mesa Street, Suite 108A, San Francisco CA 94129, United States for further information.");
 
 
-      // more tranlsation for admonition-title as the in-built translation isn't great, needs: 注釈 -> 注
+      // more translation for admonition-title as the in-built translation isn't great, needs: 注釈 -> 注
       if (docLanguage == "ja") {
           const collection = document.getElementsByClassName("admonition-title");
           for (var i=0;i<collection.length;i++) {

docs/footer.rst

@@ -8,7 +8,7 @@ Glossary
 
 .. data:: coordinate
 
-        This is an esential general mathematical / geometrical term for understanding this documentation. Please see this section for a more detailed discussion: :ref:`Coordinates`.
+        This is an essential general mathematical / geometrical term for understanding this documentation. Please see this section for a more detailed discussion: :ref:`Coordinates`.
 
 .. data:: matrix_like
 

docs/glossary.rst

@@ -1546,7 +1546,7 @@ In a nutshell, this is what you can do with PyMuPDF:
 
       Specifying `extended=True` significantly alters the output. Most importantly, new dictionary types are present: "clip" and "group". All paths will now be organized in a hierarchic structure which is encoded by the new integer key "level", the hierarchy level. Each group or clip establishes a new hierarchy, which applies to all subsequent paths having a *larger* level value. (New in v1.22.0)
 
-      Any path with a smaller level value than its predecessor will end the scope of (at least) the preceeding hierarchy level. A "clip" path with the same level as the preceding clip will end the scope of that clip. Same is true for groups. This is best explained by an example::
+      Any path with a smaller level value than its predecessor will end the scope of (at least) the preceding hierarchy level. A "clip" path with the same level as the preceding clip will end the scope of that clip. Same is true for groups. This is best explained by an example::
 
          +------+------+--------+------+--------+
          | line | lvl0 | lvl1   | lvl2 |  lvl3  |

docs/page.rst

@@ -42,7 +42,7 @@ If you want to put an **existing** image under the control of an OCG, you must f
 
 To **remove** an OCG from an image, do `doc.set_oc(img_xref, 0)`.
 
-One single OCG can be assigned to mutiple PDF objects to control their visibility.
+One single OCG can be assigned to multiple PDF objects to control their visibility.
 
 How to Define Complex Optional Content Conditions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/recipes-optional-content.rst

@@ -335,7 +335,7 @@ Outputting HTML tables is supported as follows:
 * Column widths are computed automatically based on column content. They cannot be directly set.
 * Table **cells may contain images** which will be considered in the column width calculation magic.
 * Row heights are computed automatically based on row content - leading to multi-line rows where needed.
-* The potentially multiple lines of a table row will always be kept together on one page (respectively "where" rectangle) and not be splitted.
+* The potentially multiple lines of a table row will always be kept together on one page (respectively "where" rectangle) and not be split.
 * Table header rows are only **shown on the first page / "where" rectangle.**
 * The "style" attribute is ignored when given directly in HTML table elements. Styling for a table and its elements must happen separately, in CSS source or within the :htmlTag:`style` tag.
 * Styling for :htmlTag:`tr` elements is not supported and ignored. Therefore, a table-wide grid or alternating row background colors are not supported. One of the following example scripts however shows an easy way to deal with this limitation.

docs/recipes-stories.rst

@@ -612,7 +612,7 @@ As these four font files are located in the system's folder `C:/Windows/Fonts` t
 
     # These statements define which font file to use for regular, bold,
     # italic and bold-italic text.
-    # We assign an arbitary common font-family for all 4 font files.
+    # We assign an arbitrary common font-family for all 4 font files.
     # The Story algorithm will select the right file as required.
     # We request to use "comic" throughout the text.
     css = """

docs/recipes-text.rst

@@ -1001,7 +1001,7 @@ Annotations (:ref:`Annot`) on pages can be retrieved with the `page.annots()` me
 Redacting content from a **PDF**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Redactions are special types of annotations which can be marked onto a document page to denote an area on the page which should be securely removed. After marking an area with a rectangle then this area will be marked for *redaction*, once the redaction is *applied* then the content is securly removed.
+Redactions are special types of annotations which can be marked onto a document page to denote an area on the page which should be securely removed. After marking an area with a rectangle then this area will be marked for *redaction*, once the redaction is *applied* then the content is securely removed.
 
 For example if we wanted to redact all instances of the name "Jane Doe" from a document we could do the following:
 

docs/the-basics.rst

@@ -274,7 +274,7 @@ Possible values of :attr:`linkDest.kind` (link destination kind).
 
     3 -- Launch (open) another file (of any "executable" type).
 
-    * |PyMuPDF| treats any external link that starts wth `file:` or doesn't
+    * |PyMuPDF| treats any external link that starts with `file:` or doesn't
       contain a colon, as `LINK_LAUNCH`.
 
     :rtype: int

docs/vars.rst

@@ -2369,7 +2369,7 @@ def set_properties(
             ):
         """Set any or all properties of a node.
 
-        To be used for existing nodes preferrably.
+        To be used for existing nodes preferably.
         """
         root = self.root
         temp = root.add_division()
@@ -2659,7 +2659,7 @@ def __init__(self, filename=None, stream=None, filetype=None, rect=None, width=0
             on open (e.g. EPUB). Ignored if n/a.
         """
         # We temporarily set JM_mupdf_show_errors=0 while we are constructing,
-        # then restore its orginal value in a `finally:` block.
+        # then restore its original value in a `finally:` block.
         #
         global JM_mupdf_show_errors
         JM_mupdf_show_errors_old = JM_mupdf_show_errors
@@ -4393,7 +4393,7 @@ def insert_file(self,
         Insert an arbitrary supported document to an existing PDF.
 
         The infile may be given as a filename, a Document or a Pixmap.
-        Other paramters - where applicable - equal those of insert_pdf().
+        Other parameters - where applicable - equal those of insert_pdf().
         '''
         src = None
         if isinstance(infile, Pixmap):
@@ -6909,7 +6909,7 @@ def __init__(self):
         self.text_fontsize = 0
         self.text_maxlen = 0  # text fields only
         self.text_format = 0  # text fields only
-        self._text_da = ""  # /DA = default apparance
+        self._text_da = ""  # /DA = default appearance
 
         self.script = None  # JavaScript (/A)
         self.script_stroke = None  # JavaScript (/AA/K)
@@ -7949,7 +7949,7 @@ def _insert_image(self,
                 #log( 'do_have_imask')
                 # mupdf.FzCompressedBuffer is not copyable, so
                 # mupdf.fz_compressed_image_buffer() does not work - it cannot
-                # return by value. And sharing a fz_compressed_buffer betwen two
+                # return by value. And sharing a fz_compressed_buffer between two
                 # `fz_image`'s doesn't work, so we use a raw fz_compressed_buffer
                 # here, not a mupdf.FzCompressedBuffer.
                 #
@@ -7981,7 +7981,7 @@ def _insert_image(self,
                 # `fz_compressed_buffer`, which is not reference counted, and they
                 # both think that they own it.
                 #
-                # So we do what the classic implementataion does, and simply ensure
+                # So we do what the classic implementation does, and simply ensure
                 # that `fz_drop_image(image)` is never called. This will leak
                 # some of `image`'s allocations (for example the main `fz_image`
                 # allocation), but it's not trivial to avoid this.
@@ -10468,7 +10468,7 @@ def size(self):
         """Pixmap size."""
         if mupdf_version_tuple >= (1, 23, 8):
             return  mupdf.fz_pixmap_size( self.this)
-        # fz_pixmap_size() is not publically visible, so we implement it
+        # fz_pixmap_size() is not publicly visible, so we implement it
         # ourselves. fixme: we don't add on sizeof(fz_pixmap).
         pm = self.this
         return pm.n() * pm.w() * pm.h()
@@ -10859,7 +10859,7 @@ def is_convex(self):
         if p1.y * p2.y > 0:
             return False
         m = planish_line(self.ll, self.ur)  # puts other diagonal on x-axis
-        p1 = self.lr * m  # tranform the
+        p1 = self.lr * m  # transform the
         p2 = self.ul * m  # remaining points
         if p1.y * p2.y > 0:
             return False
@@ -11294,8 +11294,8 @@ def draw_bezier(
 
     def draw_circle(self, center: point_like, radius: float):# -> Point:
         """Draw a circle given its center and radius."""
-        if not radius > EPSILON:
-            raise ValueError("radius must be postive")
+        if not radius > EPSILON:s
+            raise ValueError("radius must be positive")
         center = Point(center)
         p1 = center - (radius, 0)
         return self.draw_sector(center, p1, 360, fullSector=False)
@@ -11884,7 +11884,7 @@ def add_pdf_links(document_or_stream, positions):
             `document_or_stream` if a `Document` instance, otherwise a
             new `Document` instance.
         We raise an exception if an `href` in `positions` refers to an
-        internal position `#<name>` but no item in `postions` has `id =
+        internal position `#<name>` but no item in `positions` has `id =
         name`.
         """
         if isinstance(document_or_stream, Document):
@@ -12216,7 +12216,7 @@ def ret():
         def update(parameter):
             '''
             Evaluates `more, _ = self.place(fn(parameter))`. If `more` is
-            false, then `rect` is big enought to contain `self` and we
+            false, then `rect` is big enough to contain `self` and we
             set `state.pmax=parameter` and return True. Otherwise we set
             `state.pmin=parameter` and return False.
             '''
@@ -12402,7 +12402,7 @@ def _extractText(self, format_):
         # fixme: mupdfwrap.py thinks fz_output is not copyable, possibly
         # because there is no .refs member visible and no fz_keep_output() fn,
         # although there is an fz_drop_output(). So mupdf.fz_new_output_with_buffer()
-        # doesn't convert the returnd fz_output* into a mupdf.FzOutput.
+        # doesn't convert the returned fz_output* into a mupdf.FzOutput.
         #out = mupdf.FzOutput(out)
         if format_ == 1:
             mupdf.fz_print_stext_page_as_html(out, this_tpage, 0)
@@ -17002,7 +17002,7 @@ def JM_quad_from_py(r):
 
 def JM_read_contents(pageref):
     '''
-    Read and concatenate a PDF page's /Conents object(s) in a buffer
+    Read and concatenate a PDF page's /Contents object(s) in a buffer
     '''
     assert isinstance(pageref, mupdf.PdfObj), f'{type(pageref)}'
     contents = mupdf.pdf_dict_get(pageref, mupdf.PDF_ENUM_NAME_Contents)
@@ -19147,7 +19147,7 @@ def write(self, ctx, data_raw, data_length):
 
 def compute_scissor(dev):
     '''
-    Every scissor of a clip is a sub rectangle of the preceeding clip scissor
+    Every scissor of a clip is a sub rectangle of the preceding clip scissor
     if the clip level is larger.
     '''
     if dev.scissors is None:
@@ -19892,7 +19892,7 @@ def annot_preprocess(page: "Page") -> int:
 
 
 def annot_postprocess(page: "Page", annot: "Annot") -> None:
-    """Clean up after annotation inertion.
+    """Clean up after annotation insertion.
 
     Set ownership flag and store annotation in page annotation dictionary.
     """
@@ -20341,10 +20341,10 @@ def util_invert_matrix(matrix):
                 or abs( matrix.c - 0) >= sys.float_info.epsilon
                 or abs( matrix.d - 1) >= sys.float_info.epsilon
                 ):
-            # Invertion not possible.
+            # Inversion not possible.
             return 1, ()
         return 0, (ret.a, ret.b, ret.c, ret.d, ret.e, ret.f)
-    # Do invertion in python.
+    # Do inversion in python.
     src = JM_matrix_from_py(matrix)
     a = src.a
     det = a * src.d - src.b * src.c
@@ -20811,7 +20811,7 @@ def sRGB_to_pdf(srgb: int) -> tuple:
     Args:
         srgb: (int) RRGGBB (red, green, blue), each color in range(255).
     Returns:
-        Tuple (red, green, blue) each item in intervall 0 <= item <= 1.
+        Tuple (red, green, blue) each item in interval 0 <= item <= 1.
     """
     t = sRGB_to_rgb(srgb)
     return t[0] / 255.0, t[1] / 255.0, t[2] / 255.0
@@ -20825,7 +20825,7 @@ def sRGB_to_rgb(srgb: int) -> tuple:
     Args:
         srgb: (int) RRGGBB (red, green, blue), each color in range(255).
     Returns:
-        Tuple (red, green, blue) each item in intervall 0 <= item <= 255.
+        Tuple (red, green, blue) each item in interval 0 <= item <= 255.
     """
     r = srgb >> 16
     g = (srgb - (r << 16)) >> 8

src/__init__.py

@@ -180,7 +180,7 @@ def test_3207():
     """Example graphics with multiple "close path" commands within same path.
 
     The fix translates a close-path commands into an additional line
-    which connects the current point with a preceeding "move" target.
+    which connects the current point with a preceding "move" target.
     The example page has 2 paths which each contain 2 close-path
     commands after 2 normal "line" commands, i.e. 2 command sequences
     "move-to, line-to, line-to, close-path".