docs: meaning of argument "format"?

yazdipour / OmnivoreQL

@Omnivore-app API client for Python

https://pypi.org/project/omnivoreql/

MIT License

69 stars 6 forks source link

docs: meaning of argument "format"? #8

Closed thiswillbeyourgithub closed 5 months ago

thiswillbeyourgithub commented 8 months ago

Hi,

taking a look at help(OmnivoreQL.get_article) I see the argument "format: str = None" but can't find anywhere what the expected values are and what the effects are.

Thank you for clarifying this to me.

yazdipour commented 5 months ago

It is not clear based on their documentation what format exactly means. But bydefault html is returned and you can also change it to markdown. I have update the code and pydoc to include this information. https://github.com/yazdipour/OmnivoreQL/pull/19/commits/f88564a3bc6aca7bb0698c7bc698ea25590bdab2