menekis/OCRmyPDF
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: some cleanup

Browse Source
This commit is contained in:
James R. Barlow
2019-07-27 04:04:33 -07:00
parent 85c90404d7
commit e4cfcec5f3
3 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api.rst
+8 -6
View File
@@ -31,11 +31,13 @@ Instead, output should be managed by configuring logging.
Parent process requirements
---------------------------
The :func:`ocrmypdf.run` function runs OCRmyPDF similar to command line
execution. To do this, it will: - create a monitoring thread - create
worker processes (forking itself) - manage the signal flags of worker
processes 0 execute other subprocesses (forking and executing other
programs)
The :func:`ocrmypdf.ocr` function runs OCRmyPDF similar to command line
execution. To do this, it will:
- create a monitoring thread
- create worker processes (forking itself)
- manage the signal flags of worker processes
- execute other subprocesses (forking and executing other programs)
The Python process that calls ``ocrmypdf.ocr()`` must be sufficiently
privileged to perform these actions. If it is not, ``ocrmypdf()`` will
@@ -88,7 +90,7 @@ When OCRmyPDF succeeds conditionally, it returns an integer exit code.
Reference
---------
.. autofunction:: ocrmypdf.run
.. autofunction:: ocrmypdf.ocr
.. autoclass:: ocrmypdf.Verbosity
:members: