From: luz paz Date: Sun, 17 Apr 2022 20:04:39 +0000 (-0400) Subject: Fix documentation typos X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=b906260e7255da93cef5490927b639ead6eb322d;p=blog.git Fix documentation typos --- diff --git a/doc/css/page-layout.rst b/doc/css/page-layout.rst index faf6235e..bad598d1 100644 --- a/doc/css/page-layout.rst +++ b/doc/css/page-layout.rst @@ -383,7 +383,7 @@ markup together with 10-column grid setup around the main content:

A page

-

Some introductionary paragraph.

+

Some introductory paragraph.

Features

Section providing feature overview.

@@ -405,7 +405,7 @@ landing pages. The major component of a landing page is a cover image in the background, spanning the whole page width in a :css:`#m-landing-image` element. The image is covered by :css:`#m-landing-cover` element that blends the image into the background on the bottom. On top of it you have full freedom to put -any layout you need, for example a logo, a short introductionary paragraph and +any layout you need, for example a logo, a short introductory paragraph and a download button. Note that the grid setup has to only wrap the content "below the fold", *not* the cover image. @@ -514,7 +514,7 @@ Consider the following code snippet:

A page

-

Some introductionary paragraph.

+

Some introductory paragraph.

Features

Section providing feature overview.

@@ -526,7 +526,7 @@ Consider the following code snippet:
Clicking on either the "Features" or "Pricing" heading will give the user a -direct link to given section and the section will be highlighed accordingly. +direct link to given section and the section will be highlighted accordingly. This works for nested sections as well. .. note-success:: diff --git a/doc/why.rst b/doc/why.rst index ecb27b21..8e8abdf2 100644 --- a/doc/why.rst +++ b/doc/why.rst @@ -108,7 +108,7 @@ thought out, amazingly flexible and easily extensible to support .. note-warning:: By all means, use Jekyll or Hugo, if you want --- but I can't promise that - all the :abbr:`reST ` extensions I did are transferrable + all the :abbr:`reST ` extensions I did are transferable elsewhere. Why the name? diff --git a/documentation/doxygen.py b/documentation/doxygen.py index 2be78596..5fa5d6e6 100755 --- a/documentation/doxygen.py +++ b/documentation/doxygen.py @@ -2157,7 +2157,7 @@ def parse_func(state: State, element: ET.Element): state.search += [result] # Return the function only if it has some documentation. Testing just for - # func.has_details would errorneously omit functions that have e.g. just + # func.has_details would erroneously omit functions that have e.g. just # /** @overload */ from file docs. return func if func.brief or can_have_details else None