Skip to content

docs: update sdk api docs#46

Closed
briangreunke wants to merge 5 commits into
mainfrom
brian/eng-1914-docs-update-sdk-api-docs
Closed

docs: update sdk api docs#46
briangreunke wants to merge 5 commits into
mainfrom
brian/eng-1914-docs-update-sdk-api-docs

Conversation

@briangreunke
Copy link
Copy Markdown
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
@monoxgas monoxgas closed this Jun 8, 2025
@monoxgas monoxgas deleted the brian/eng-1914-docs-update-sdk-api-docs branch June 17, 2025 17:35
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.

2 participants