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.

Sign up for GitHub

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

Jump to bottom

Docs from code #165

Open
6 tasks
Tracked by #166
cert-ee-raidar opened this issue Sep 24, 2024 · 0 comments
Open
6 tasks
Tracked by #166

Docs from code #165

cert-ee-raidar opened this issue Sep 24, 2024 · 0 comments
Assignees
@cert-ee-raidar
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Reference manual

Comments

@cert-ee-raidar
Copy link
Contributor

cert-ee-raidar commented Sep 24, 2024 •
edited
Loading

Goal

All functions, classes, and methods need docstrings.
The goal is to generate a reference manual from code.
Docs from code must be automated.

Modules

  • common
  • core
  • node
  • processing
  • web
  • machineries
@cert-ee-raidar cert-ee-raidar added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 24, 2024
@cert-ee-raidar cert-ee-raidar self-assigned this Sep 24, 2024
@cert-ee-raidar cert-ee-raidar mentioned this issue Sep 24, 2024
Open
1 task
@cert-ee-raidar cert-ee-raidar moved this to Backlog in Cuckoo3 Sep 30, 2024
@cert-ee-raidar cert-ee-raidar added this to the Reference manual milestone Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cert-ee-raidar cert-ee-raidar

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Cuckoo3
Status: Backlog
Milestone
Reference manual
Development

No branches or pull requests
1 participant
@cert-ee-raidar