Struct Recommendation 

pub struct Recommendation {
    pub id: String,
    pub recommendation_type: RecommendationType,
    pub priority: u8,
    pub title: String,
    pub description: String,
    pub affected_files: Vec<PathBuf>,
    pub estimated_effort_hours: Option<f32>,
    pub resolves_issues: Vec<String>,
}

Available on crate feature doc-audit only.

Actionable recommendation for improving documentation.

Fields

id: String

Unique identifier for this recommendation

recommendation_type: RecommendationType

Type of recommendation

priority: u8

Priority level (1 = highest, 5 = lowest)

title: String

Title of the recommendation

description: String

Detailed description

affected_files: Vec<PathBuf>

Files that would be affected by this recommendation

estimated_effort_hours: Option<f32>

Estimated effort to implement (in hours)

resolves_issues: Vec<String>

Issues that would be resolved by this recommendation

Implementations

impl Recommendation

pub fn new( recommendation_type: RecommendationType, title: String, description: String, ) -> Recommendation

Create a new recommendation.

pub fn with_priority(self, priority: u8) -> Recommendation

Set the priority for this recommendation (1 = highest, 5 = lowest).

pub fn with_affected_file(self, file_path: PathBuf) -> Recommendation

Add an affected file.

pub fn with_estimated_effort(self, hours: f32) -> Recommendation

Set the estimated effort in hours.

pub fn resolves_issue(self, issue_id: String) -> Recommendation

Add an issue that this recommendation would resolve.

Trait Implementations

impl Clone for Recommendation

fn clone(&self) -> Recommendation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Recommendation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Recommendation

fn deserialize<__D>( __deserializer: __D, ) -> Result<Recommendation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Recommendation

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.