DOC update pyrit.common API reference
#657
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Looks great! Mark as non-draft and we can merge :) |
rlundeen2
approved these changes
Jan 23, 2025
|
Alright! I just have one question: I noticed several other functions and classes in the common module have existing documentation. Would you like me to also add these to the API reference to improve overall documentation coverage? I'm currently working on it. It's almost done :) |
|
Yes, great! All of that's a welcome change, thank you for helping improve our docs :) |
|
@microsoft-github-policy-service agree |
paulinek13
changed the title
initialize_pyrit to API referenceinitialize_pyrit to API reference
paulinek13
changed the title
initialize_pyrit to API referencepyrit.common API reference
Add functions and classes with existing documentation to the `pyrit.common` API reference.
paulinek13
force-pushed
the
doc/common-api-ref
branch
from
0f4a5a8 to
9148bfa
Compare
rlundeen2
reviewed
Jan 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the
initialize_pyritfunction to the API reference indoc/api.rst.Related issue: #653
Tests and Documentation
Verified documentation generation using
jupyter-book build doc