Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation is very incomplete #1

Open
tobwen opened this issue Apr 29, 2024 · 1 comment
Open

documentation is very incomplete #1

tobwen opened this issue Apr 29, 2024 · 1 comment

Comments

@tobwen
Copy link

tobwen commented Apr 29, 2024

The documentation is shockingly and disappointingly incomplete.

Here is an example. It is not clear how the parameters could work. The parameters have no error message and are not self-explanatory at all:

### `tag`
Tag operations on PDF
_Options:_
```
-i,--input TEXT:FILE Input file
-o,--output TEXT Output file
-r,--remove
-a,--annotation
-f,--artefact
-g,--heading
-d,--reading-order
-s,--read-struct-tree
-e,--edit-struct-tree
-t,--table-as-figure
```

I don't have any clue, how to edit the struct tree...

Unfortunately, the product isn't open source, so nobody can help to improve the documentation except to find possible typos - is it pocess or processs?

### `pocess-control`
test commands
_Options:_
```
-i,--input TEXT:FILE Input file
```

@jenstroeger
Copy link

SDK documentation isn’t available: the link https://pdfix.github.io/pdfix_sdk_builds/en/8.0.1/html/index.html here doesn’t exist, and neither does https://pdfix.github.io/.

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

No branches or pull requests

2 participants