Project

General

Profile

Actions
Copy link

Documentation #4584

closed

Rust doc: add docstring to rust module files

Added by Juliana Fajardini Reichow about 3 years ago. Updated about 1 year ago.

Status:
Closed
Priority:
Normal
Assignee:
Daniel Olatunji
Target version:
7.0.3
Affected Versions:
Effort:
Difficulty:
Label:
Beginner, Good First Issue, Outreachy, Rust

Description

Currently, the majority of Rust modules in Suricata have no brief description, when one generates rust documentation, as shown:


Adding a comment like

//! Module brief description

would suffice for giving some context on the modules.

Files

clipboard-202108131242-ygxvz.png (43.6 KB) clipboard-202108131242-ygxvz.png Juliana Fajardini Reichow, 08/13/2021 11:42 AM
Actions
Copy link
 #1

Updated by Juliana Fajardini Reichow about 3 years ago

  • Label Beginner, Outreachy, Rust added
Actions
Copy link
 #2

Updated by Juliana Fajardini Reichow about 3 years ago

  • Label Good First Issue added
Actions
Copy link
 #3

Updated by Juliana Fajardini Reichow about 3 years ago

  • Label deleted (Outreachy)
Actions
Copy link
 #4

Updated by Juliana Fajardini Reichow about 3 years ago

  • Label Outreachy added
Actions
Copy link
 #5

Updated by Juliana Fajardini Reichow over 1 year ago

  • Assignee set to Community Ticket
  • Target version changed from TBD to 8.0.0-beta1
Actions
Copy link
 #6

Updated by Daniel Olatunji about 1 year ago

  • Status changed from New to Assigned
  • Assignee changed from Community Ticket to Daniel Olatunji
Actions
Copy link
 #7

Updated by Daniel Olatunji about 1 year ago

  • Status changed from Assigned to In Review
Actions
Copy link
 #8

Updated by Daniel Olatunji about 1 year ago

  • Status changed from In Review to Resolved
Actions
Copy link
 #9

Updated by Daniel Olatunji about 1 year ago

  • Status changed from Resolved to Closed
Actions
Copy link
 #10

Updated by Juliana Fajardini Reichow about 1 year ago

  • Target version changed from 8.0.0-beta1 to 7.0.3
Actions
Copy link

Also available in: Atom PDF