Skip to content

docs: update sdk api docs #46

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

briangreunke
Copy link
Contributor

@briangreunke briangreunke commented May 9, 2025

Regenerated Docs

Key Changes:

  • Regenerated docstrings for all modules, classes, and methods
  • Regenerated docs from docstrings

Added:

  • New docs for new modules
  • Docstrings

Generated Summary:

  • Added extensive docstrings throughout the Dreadnode SDK modules to improve code documentation.
  • Documented core class functionalities and attributes for key components such as ApiClient, Task, Run, and more.
  • Introduced module-level documentation for clarity on purpose and usage in dreadnode, dreadnode.api, dreadnode.artifact, and dreadnode.integrations.
  • Enhanced existing class and method documentation with detailed parameter and return value descriptions across the SDK.
  • This update aims to improve developer experience by providing comprehensive guidance and examples directly in the codebase.
  • No changes to functionality or logic; this is purely a documentation enhancement.

This summary was generated with ❤️ by rigging

@dreadnode-renovate-bot dreadnode-renovate-bot bot added area/docs Changes to documentation and guides type/docs Documentation updates and improvements labels May 9, 2025
@briangreunke briangreunke changed the title Brian/eng 1914 docs update sdk api docs docs: update sdk api docs May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Changes to documentation and guides type/docs Documentation updates and improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant