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.

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

DOC API reference has missing or malformed content #653

Open
romanlutz opened this issue Jan 21, 2025 · 0 comments
Open

DOC API reference has missing or malformed content #653

romanlutz opened this issue Jan 21, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@romanlutz
Copy link
Contributor

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!

@romanlutz romanlutz added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant