Skip to content

Commit

Permalink
docs: fix spellings
Browse files Browse the repository at this point in the history
  • Loading branch information
bepri committed Feb 4, 2025
1 parent 81f65ac commit 3ffe9b8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ subdirectories
subtree
subfolders
Subpackages
testcraft
UI
utils
VM
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-guides/use-completion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Use the completion module

Craft-cli provides a completion module for auto-generating bash completion scripts for applications using its :py:class:`Dispatcher`.

In order to invoke it, the application needs to have a public function that returns some basic information about itself. All applications must provide their :py:class:`Dispatcher` and a config to initialize commands with. By default, craft-cli commands don't need to be initialized with anything, so this would be ``None`` in the basic case.
In order to invoke it, the application needs to have a public function that returns some basic information about itself. All applications must provide their :py:class:`Dispatcher` and a configuration to initialise commands with. By default, craft-cli commands don't need to be initialized with anything, so this would be ``None`` in the basic case.

For a project named "testcraft", create the file :file:`testcraft/application.py` and add the following content:

Expand All @@ -28,7 +28,7 @@ Once the function is made, the completion module can be invoked to create the co
Applications using craft-application
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Commands from `craft-application`_ need their ``app_config`` dictionary in order to be initialized. To handle this, return the ``app_config`` alongside the application's :py:class:`Dispatcher` object:
Commands from `craft-application`_ need their ``app_config`` dictionary in order to be initialised. To handle this, return the ``app_config`` alongside the application's :py:class:`Dispatcher` object:

.. code:: python
Expand Down

0 comments on commit 3ffe9b8

Please sign in to comment.