RelationalAI / rai-sdk-python

The RelationalAI Software Development Kit (SDK) for Python.
Apache License 2.0
17 stars 4 forks source link

Use python doc comments for API methods #84

Open gbrgr opened 2 years ago

gbrgr commented 2 years ago

I saw that many functions are documented like:

# Documentation lorem ipsum
def function(...):
    ...

To follow the pythonic way, we should do

def function(...):
"""Documentation lorem ipsum"""
    ...
billscheidel-rai commented 1 year ago

Note: This issue has been migrated to https://relationalai.atlassian.net/browse/RAI-5215.

This link is only accessible to employees of RelationalAI.