Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@bertsky
Copy link
Collaborator

@bertsky bertsky commented Mar 27, 2023

Note: I have not found a way to bypass the module-level docstring yet.

This will be ocrd.cli.ocrd_tool, for example for bashlib based ocrd-page-transform:

Usage: ocrd-page-transform [OPTIONS]

  apply arbitrary XSL transformation file for PAGE-XML

  > OCR-D CLI: ocrd-tool.json management

  > .. click:: ocrd.cli.ocrd_tool:ocrd_tool_cli     :prog: ocrd ocrd-
  > tool     :nested: full

...

Still, that's better than before, when it also wrote the Processor and Processor.process docstring:

  > Processor base class and helper functions. A processor is a tool
  > that implements the uniform OCR-D command-line interface for run-
  > time data processing. That is, it executes a single workflow step,
  > or a combination of workflow steps, on the workspace (represented by
  > local METS). It reads input files for all or requested physical
  > pages of the input fileGrp(s), and writes output files for them into
  > the output fileGrp(s). It may take  a number of optional or
  > mandatory parameters. Process the :py:attr:`workspace`  from the
  > given :py:attr:`input_file_grp` to the given
  > :py:attr:`output_file_grp` for the given :py:attr:`page_id` under
  > the given :py:attr:`parameter`.

  > (This contains the main functionality and needs to be overridden by
  > subclasses.)

Copy link
Collaborator Author

@bertsky bertsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not ready

@kba kba changed the title ocrd_tool help: remove default docstrings (used by bashlib's ocrd__uage) ocrd_tool help: remove default docstrings (used by bashlib's ocrd__usage) Mar 28, 2023
@bertsky bertsky requested a review from kba March 28, 2023 18:58
@kba kba merged commit 05ece40 into OCR-D:master Apr 2, 2023
@bertsky bertsky deleted the bashlib-usage-docstrings branch June 6, 2024 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants