fix: Fix various documentation issues #42

cameronwaterman · 2023-01-23T19:10:20Z

Fixes the following documentation bugs:

We aren't documenting any "raises" such as ApiException
The DataFrameClient's __init__ references core.JupyterHttpConfiguration, but it didn't render as a link (compare to TagManager.create_selection)
Most of the DataFrameClient methods include a name for the return type that renders as a textual link instead of a code reference link.

Documentation fixes.

Checked docs produced as part of PR build.

cameronwaterman · 2023-01-23T20:13:40Z

Not sure if there are established best practices for documenting exceptions - open to suggestions.

nisystemlink/clients/dataframe/_data_frame_client.py

cameronwaterman added 9 commits January 23, 2023 13:05

First pass

f0e8b38

Fix return type

486145a

Fix return types

6ec730e

Format

62f06b7

Fix JupyterHttpConfiguration link

75e3161

Attempt to fix link

fd9ae07

Use fully qualified path

42481f3

Shorten link

27ceee0

Use explicit title for link

888863c

cameronwaterman marked this pull request as ready for review January 23, 2023 20:13

cameronwaterman requested review from mure and spanglerco as code owners January 23, 2023 20:13

spanglerco approved these changes Jan 25, 2023

View reviewed changes

nisystemlink/clients/dataframe/_data_frame_client.py Outdated Show resolved Hide resolved

If -> if

1027f4f

mure approved these changes Jan 26, 2023

View reviewed changes

cameronwaterman merged commit 872e9ac into master Jan 26, 2023

cameronwaterman deleted the users/cwaterma/fix-docs-issues branch January 26, 2023 14:56

Provide feedback