Skip to content

Commit

Permalink
Fix documentation typos
Browse files Browse the repository at this point in the history
Replace wrong  mentions of libzim with libkiwix
Remove libkiwix deprecated functions mention in usage.rst - they are removed now
  • Loading branch information
juuz0 committed Jun 25, 2022
1 parent 15cb902 commit e9b7eeb
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

project = 'libkiwix'
copyright = '2022, libkiwix-team'
author = 'libzim-team'
author = 'libkiwix-team'


# -- General configuration ---------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to libzim's documentation!
Welcome to libkiwix's documentation!
==================================

.. toctree::
Expand Down
4 changes: 1 addition & 3 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ Introduction
libkiwix is written in C++. To use the library, you need the include files of libkiwix have
to link against libzim.

Errors are handled with exceptions. When something goes wrong, libzim throws an error,
Errors are handled with exceptions. When something goes wrong, libkiwix throws an error,
which is always derived from std::exception.

All classes are defined in the namespace kiwix.

libkiwix is a set of tools to manage zim files and provide some common functionnality.
While libkiwix has some wrappers around libzim classes, they are deprecated and will be removed
in the future.

0 comments on commit e9b7eeb

Please sign in to comment.