Skip to content
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

task: document Python SDK API #19

Closed
wvandeun opened this issue Mar 2, 2024 · 1 comment
Closed

task: document Python SDK API #19

wvandeun opened this issue Mar 2, 2024 · 1 comment
Labels
type/documentation Improvements or additions to documentation type/task Body of work related to an epic

Comments

@wvandeun
Copy link
Contributor

wvandeun commented Mar 2, 2024

Component

Python SDK

Task Description

We should provide reference documentation of the Python SDK API.
This could be auto generated documentation of the available classes and functions, preferably from the docstrings.

We should be able to find which functions are available and how they are supposed to be used, which arguments need to be provided and their type.
@wvandeun wvandeun added type/documentation Improvements or additions to documentation type/task Body of work related to an epic labels Mar 2, 2024
@dgarros dgarros transferred this issue from opsmill/infrahub Sep 21, 2024
@dgarros
Copy link
Contributor

dgarros commented Jan 2, 2025

I created a new one by mistake, my bad
#201

Since there other one has more info I'll close this one

@dgarros dgarros closed this as not planned Won't fix, can't repro, duplicate, stale Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type/documentation Improvements or additions to documentation type/task Body of work related to an epic
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dgarros @wvandeun