Skip to content

[Feature Request] #1

@Andrewsimsd

Description

@Andrewsimsd

Describe the feature you'd like
Add a Panics section if the code can panic. This is indicated by .unwrap(), lexpect, and panic()!. There may be more panic syntax

Why is this feature important?
clippy pedantic

Describe alternatives you've considered
typing it myself

Example Output:

    /// Describe this function.
    /// 
    /// # Arguments
    /// 
    /// - `&self` (`undefined`) - Describe this parameter.
    /// 
    /// # Panics
    /// 
    /// # Examples
    /// 
    /// ```
    /// use crate::...;
    /// 
    /// let _ = display();
    /// ```
    pub fn display(&self) {
        let mut output = String::new();
        self.write_display(&mut output).unwrap();
        println!("{}", output);
    }

Additional context
Add any other context or mockups here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions