Skip to content

Use python doc comments for API methods #84

Open

Description

@gbrgr

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

Activity

  1. billscheidel-rai commented on Dec 6, 2022

    @billscheidel-rai

    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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions