itsscb/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-10-01 11:31:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: format assist doc for sourcegen_assists_docs

Browse Source
This commit is contained in:
Côme ALLART 2021-12-06 19:04:44 +01:00
parent 998b91af9c
commit d55d3b63cb
2 changed files with 58 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
crates/ide_assists/src/handlers/generate_documentation_template.rs
View File

@ -7,35 +7,34 @@ use syntax::{
use crate::assist_context::{AssistContext, Assists};
/// Assist: generate_documentation_template
///
/// Adds a documentation template above a function definition / declaration
///
/// ```
/// fn my_func(a: i32, b: i32) -> Result<(), std::io::Error> {
/// unimplemented!()
/// }
/// ```
/// ->
/// ```
/// /// .
/// ///
/// /// # Examples
/// ///
/// /// ```rust
/// /// use my_crate::my_func;
/// ///
/// /// let result = my_func(a, b);
/// /// assert_eq!(result, );
/// /// ```
/// ///
/// /// # Errors
/// ///
/// /// This function will return an error if .
/// fn my_func(a: i32, b: i32) -> Result<(), std::io::Error> {
/// unimplemented!()
/// }
/// ```
// Assist: generate_documentation_template
//
// Adds a documentation template above a function definition / declaration.
//
// ```
// fn my_$0func(a: i32, b: i32) -> Result<(), std::io::Error> {
// unimplemented!()
// }
// ```
// ->
// ```
// /// .
// ///
// /// # Examples
// ///
// /// ```
// /// use test::my_func;
// ///
// /// assert_eq!(my_func(a, b), );
// /// ```
// ///
// /// # Errors
// ///
// /// This function will return an error if .
// fn my_func(a: i32, b: i32) -> Result<(), std::io::Error> {
// unimplemented!()
// }
// ```
pub(crate) fn generate_documentation_template(
acc: &mut Assists,
ctx: &AssistContext,

30
crates/ide_assists/src/tests/generated.rs
View File

@ -839,6 +839,36 @@ struct Point {
)
}
#[test]
fn doctest_generate_documentation_template() {
check_doc_test(
"generate_documentation_template",
r#####"
fn my_$0func(a: i32, b: i32) -> Result<(), std::io::Error> {
unimplemented!()
}
"#####,
r#####"
/// .
///
/// # Examples
///
/// ```
/// use test::my_func;
///
/// assert_eq!(my_func(a, b), );
/// ```
///
/// # Errors
///
/// This function will return an error if .
fn my_func(a: i32, b: i32) -> Result<(), std::io::Error> {
unimplemented!()
}
"#####,
)
}
#[test]
fn doctest_generate_enum_as_method() {
check_doc_test(