New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use python doc comments for API methods #84

Open

gbrgr opened this issue May 9, 2022 · 1 comment

Labels

component:rai-sdk-python type:documentation

gbrgr commented May 9, 2022

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"""
    ...

bradlo added type:documentation component:rai-sdk-python labels

billscheidel-rai commented Dec 6, 2022

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

This link is only accessible to employees of RelationalAI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment