search

atlanhq / camelot

Camelot: PDF Table Extraction for Humans
https://camelot-py.readthedocs.io
Other
3.64k stars 354 forks source link

API Reference: I do not find strip #298

Closed aborruso closed 5 years ago

aborruso commented 5 years ago

Hi, in the API I have strip_text, but not strip.

I'm not sure, but probably it should be in that page.

Thank you

vinayak-mehta commented 5 years ago

Thanks for reporting this!

suyashb95 commented 5 years ago

Shouldn't it be added to the CLI docs?

vinayak-mehta commented 5 years ago

Yes, would you like to update the CLI docs?

suyashb95 commented 5 years ago

Sure, will submit a PR

aborruso commented 5 years ago

Hi @Suyash458 and @vinayak-mehta and thank you.

It's important for the CLI but I think it should be also in the API webpage. I do not know if it's the source of the CLI docs.

Thank you

dimitern commented 5 years ago

That's already documented it seems: https://camelot-py.readthedocs.io/en/master/user/advanced.html#strip-characters-from-text

aborruso commented 5 years ago

@dimitern that is strip_text. There is also strip (but not in the documentation)

dimitern commented 5 years ago

@dimitern that is strip_text. There is also strip (but not in the documentation)

It's the same thing, well as far as the CLI is concerned - -strip is an alias for --strip_text (see https://github.com/atlanhq/camelot/blob/master/camelot/cli.py#L62). There isn't a strip argument to the read_pdf() API though, it's only strip_text.

aborruso commented 5 years ago

@dimitern I have received this reply and then I have searched in the documentation to understand strip. I had no idea that it is an alias.

Thank you

vinayak-mehta commented 5 years ago

Closing this. Thanks @dimitern!