* docs: add docstrings for DocumentConverter
Signed-off-by: Julia Pap <papjuli@gmail.com>
* Apply suggestions from code review
Improve docstrings in DocumentConverter
Co-authored-by: Cesar Berrospi Ramis <75900930+ceberam@users.noreply.github.com>
Signed-off-by: Julia Pap <papjuli@gmail.com>
* docs: improve docstring formatting and wording in DocumentConverter
* docs: show init method in document converter reference
* docs: change back indents to 4x in DocumentConverter docstrings
griffe was issuing warnings of confusing indentation
* docs: clarify `max_num_pages` and `page_range` args in `DocumentConverter` methods
* docs: fix some Yields and Returns in DocumentConverter docstrings
* DCO Remediation Commit for Julia Pap <papjuli@gmail.com>
I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit: cf2ea4e0f0
I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit: 57446af168
I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit: 5d613edb8c
I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit: b195281f56
I, Julia Pap <papjuli@gmail.com>, hereby add my Signed-off-by to this commit: 5d4a3af5d5
Signed-off-by: Julia Pap <papjuli@gmail.com>
* docs: ignore init description, rephrased docstrings
Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>
---------
Signed-off-by: Julia Pap <papjuli@gmail.com>
Signed-off-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>
Co-authored-by: Cesar Berrospi Ramis <75900930+ceberam@users.noreply.github.com>
Co-authored-by: Cesar Berrospi Ramis <ceb@zurich.ibm.com>