doc: correct spelling mistakes and Python errors #3870

CarstenGrohmann · 2025-11-15T09:50:42Z

Pull Request Checklist

I’ve read the guidelines for contributing.
I updated AUTHORS.txt and CHANGES.txt (if the change is non-trivial) and documentation (if applicable).
I tested my changes.

Description

This PR fixes spelling mistakes and errors in the Python examples:

e.g. missing comma in

Lines 599 to 603 in e09ea79

    
               METADATA_MAPPING = { 
        
                   "rest_docinfo": {"summary": "description", "modified": "updated"}, 
        
                   "markdown_metadata": {"summary": "description", "modified": "updated"} 
        
                   "html_metadata": {"summary": "description", "modified": "updated"} 
        
               }

Kwpolska · 2025-11-15T09:54:51Z

docs/manual.rst

 for you.

-DON'T READ THIS MANUAL. IF YOU NEED TO READ IT I FAILED, JUST USE THE THING.
+DON’T READ THIS MANUAL. IF YOU NEED TO READ IT I FAILED, JUST USE THE THING.


Plain ASCII quotes are not “spelling mistakes”. Changing them to fancy quotes has no benefit and only complicates reading this PR.

I completely agree that plain ASCII quotes aren't spelling mistakes. My main goal with the curly quotes was to make the quote style consistent throughout the document (some sections already used “fancy” quotes, others used straight ones).
If you prefer to keep ASCII quotes everywhere for simplicity and consistency, that's totally fine with me—happy to revert those changes.
Should I drop the curly-quote part and keep only the actual typo fixes, or would you like me to push a new version without them?

Kwpolska · 2025-11-15T09:55:24Z

docs/manual.rst


 To add these metadata fields to all new posts by default, you can set the
-variable ``ADDITIONAL_METADATA`` in your configuration.  For example, you can
+variable ``ADDITIONAL_METADATA`` in your configuration. For example, you can


Double spacing is not wrong either and it does not show up in HTML.

That's right, not in HTML, but when manually editing the rst file.
Keep or undo?

Kwpolska · 2025-11-15T09:56:01Z

docs/manual.rst

 .. code:: python

-    # POSTS and PAGES contains (wildcard, destination, template) tuples.
+    # POSTS and PAGES contain (wildcard, destination, template) tuples.


If you’re making changes to output samples, the changes should also be applied to the codebase.

Fixed in 43cbb20

Kwpolska · 2025-11-15T09:56:35Z

docs/manual.rst

+this behavior with your ``conf.py``: ``INDEX_TEASERS`` defines whether the index
 page should display the whole contents or only teasers. ``FEED_TEASERS``


Suggested change

this behavior with your ``conf.py``: ``INDEX_TEASERS`` defines whether the index

page should display the whole contents or only teasers. ``FEED_TEASERS``

this behavior with your ``conf.py``: ``INDEX_TEASERS`` defines whether index

pages should display the whole contents or only teasers. ``FEED_TEASERS``

Fixed in 43cbb20

Kwpolska · 2025-11-15T09:56:56Z

docs/manual.rst

    THEME_CONFIG = {
        DEFAULT_LANG: {
-            # Show the latest featured post in a large box, with the previewimage as its background.
+            # Show the latest featured post in a large box, with the preview image as its background.


Undo, this is the name of the meta field.

Suggested change

# Show the latest featured post in a large box, with the preview image as its background.

# Show the latest featured post in a large box, with the previewimage as its background.

Undo in 43cbb20

Perhaps we should add some quotation marks here to make it clear to casual readers that this is a metadata field:

# Show the latest featured post in a large box, with the ``previewimage`` as its background.

Kwpolska · 2025-11-15T09:57:06Z

docs/manual.rst

            # Strip HTML from featured post text.
            'featured_strip_html': True,
-            # Contents of the sidebar, If empty, the sidebar is not displayed.
+            # Contents of the sidebar, if empty, the sidebar is not displayed.


Suggested change

# Contents of the sidebar, if empty, the sidebar is not displayed.

# Contents of the sidebar. If empty, the sidebar is not displayed.

Fixed in 43cbb20

Kwpolska · 2025-11-15T09:57:54Z

docs/manual.rst

+The next unit for organizing your content is categories. A post can have only one category, specified with the ``category`` meta tag. They are displayed alongside tags. You can have categories and tags with the same name (categories’ RSS and HTML files are prefixed with ``cat_`` by default).

-Categories are handy to organize different parts of your blog, parts that are about different topics. Unlike tags, which you should have tens (hundreds?) of, the list of categories should be shorter.
+Categories are handy to organize different parts of your blog, parts that are about different topics. Unlike tags, for which you should have tens or hundreds, the list of categories should be shorter.


Undo. for does not seem correct here.

Undo in 43cbb20

Kwpolska · 2025-11-15T09:58:22Z

docs/manual.rst

+You can pass a different configuration file by using the ``--conf`` command line switch.

-The default ``conf.py`` you get with Nikola should be fairly complete, and is quite
+The default ``conf.py`` you get with Nikola should be fairly complete and is quite


Undo in 43cbb20

Kwpolska · 2025-11-15T09:59:47Z

docs/manual.rst

    You have to install those yourself or through a package manager.

-You can also share plugins you created with the community!  Visit the
+And you can also share plugins you created with the community!  Visit the


Undo in 43cbb20

Kwpolska requested changes Nov 15, 2025

View reviewed changes

doc: correct spelling mistakes and Python errors

43cbb20

CarstenGrohmann force-pushed the 20251115_typos branch from d285587 to 43cbb20 Compare November 26, 2025 19:55

	METADATA_MAPPING = {
	"rest_docinfo": {"summary": "description", "modified": "updated"},
	"markdown_metadata": {"summary": "description", "modified": "updated"}
	"html_metadata": {"summary": "description", "modified": "updated"}
	}

		this behavior with your ``conf.py``: ``INDEX_TEASERS`` defines whether the index
		page should display the whole contents or only teasers. ``FEED_TEASERS``

	# Show the latest featured post in a large box, with the preview image as its background.
	# Show the latest featured post in a large box, with the previewimage as its background.

	# Contents of the sidebar, if empty, the sidebar is not displayed.
	# Contents of the sidebar. If empty, the sidebar is not displayed.

doc: correct spelling mistakes and Python errors #3870

Are you sure you want to change the base?

doc: correct spelling mistakes and Python errors #3870

Uh oh!

Conversation

CarstenGrohmann commented Nov 15, 2025

Pull Request Checklist

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CarstenGrohmann Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

CarstenGrohmann Nov 26, 2025 •

edited

Loading