Skip to content

DOC API reference has missing or malformed content #653

@romanlutz

Description

@romanlutz

Describe the issue linked to the documentation

Lots of parts of the API reference has missing or malformed text. Examples:

  • https://azure.github.io/PyRIT/api.html Image 4/5 entries are empty here so that needs updating. Essentially, every empty description box is a problem.
  • Image pyrit.common appears to be missing. Especially initialize_pyrit should be here.

Suggest a potential alternative/fix

Some entries in the API docs are just not needed. Perhaps we can stop exporting them? It's sometimes a reasonable fix.
Some need a simple description. Some need an improved description.

Note: one can open a PR for a single small fix. One does not have to fix all of them or even multiple to make a contribution! Every little piece helps!

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions