You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, when extended text content is added to table descriptions in the Python client documentation, the content is squeezed into narrow columns, making it a bit difficult to read.
I would propose couple changes to the mkdocs.yml configuration:
Switch to docstring_section_style: "spacy" (this style might improve table formatting by allocating more space to the description column).
Enable the following options for better page aesthetics:
separate_signature: true (this separates the method signature from the rest of the content, making it clearer.)
show_category_heading: true (this introduces category headings, adding some better structure.)
To illustrate the difference, I provide these two examples:
Currently, when extended text content is added to table descriptions in the Python client documentation, the content is squeezed into narrow columns, making it a bit difficult to read.
I would propose couple changes to the
mkdocs.yml
configuration:docstring_section_style: "spacy"
(this style might improve table formatting by allocating more space to the description column).separate_signature: true
(this separates the method signature from the rest of the content, making it clearer.)show_category_heading: true
(this introduces category headings, adding some better structure.)To illustrate the difference, I provide these two examples:
Current view
Suggested view
The text was updated successfully, but these errors were encountered: