From e9b7eeb3c907309f987bf8205553387042bfe9fb Mon Sep 17 00:00:00 2001 From: Nikhil Tanwar <2002nikhiltanwar@gmail.com> Date: Sat, 25 Jun 2022 09:44:51 +0530 Subject: [PATCH] Fix documentation typos Replace wrong mentions of libzim with libkiwix Remove libkiwix deprecated functions mention in usage.rst - they are removed now --- docs/conf.py | 2 +- docs/index.rst | 2 +- docs/usage.rst | 4 +--- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 7d369acce..e5852cbe8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ import os project = 'libkiwix' copyright = '2022, libkiwix-team' -author = 'libzim-team' +author = 'libkiwix-team' # -- General configuration --------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 20b189e57..3f40e6337 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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:: diff --git a/docs/usage.rst b/docs/usage.rst index 48faf6a27..67e742218 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -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.