fix: Fix various documentation issues - Githubissues

ni / nisystemlink-clients-python

Python API for interacting with a SystemLink Server, created and supported by NI.

https://ni.com/systemlink

MIT License

10 stars 14 forks source link

fix: Fix various documentation issues #42

Closed cameronwaterman closed 1 year ago

cameronwaterman commented 1 year ago

[X] This contribution adheres to CONTRIBUTING.md.

What does this Pull Request accomplish?

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.

Why should this Pull Request be merged?

Documentation fixes.

What testing has been done?

Checked docs produced as part of PR build.

cameronwaterman commented 1 year ago

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