fix generated docs issue

This commit is contained in:
Jess Balint 2020-05-22 09:25:55 -05:00
parent 6594235dd8
commit 1f9e02c74e
3 changed files with 72 additions and 23 deletions

View file

@ -2,29 +2,29 @@ use crate::{AssistContext, AssistId, Assists};
use ra_syntax::{ast, ast::TypeParamsOwner, AstNode, SyntaxKind};
use std::collections::HashSet;
/// Assist: change_lifetime_anon_to_named
///
/// Change an anonymous lifetime to a named lifetime.
///
/// ```
/// impl Cursor<'_<|>> {
/// fn node(self) -> &SyntaxNode {
/// match self {
/// Cursor::Replace(node) | Cursor::Before(node) => node,
/// }
/// }
/// }
/// ```
/// ->
/// ```
/// impl<'a> Cursor<'a> {
/// fn node(self) -> &SyntaxNode {
/// match self {
/// Cursor::Replace(node) | Cursor::Before(node) => node,
/// }
/// }
/// }
/// ```
// Assist: change_lifetime_anon_to_named
//
// Change an anonymous lifetime to a named lifetime.
//
// ```
// impl Cursor<'_<|>> {
// fn node(self) -> &SyntaxNode {
// match self {
// Cursor::Replace(node) | Cursor::Before(node) => node,
// }
// }
// }
// ```
// ->
// ```
// impl<'a> Cursor<'a> {
// fn node(self) -> &SyntaxNode {
// match self {
// Cursor::Replace(node) | Cursor::Before(node) => node,
// }
// }
// }
// ```
// FIXME: How can we handle renaming any one of multiple anonymous lifetimes?
pub(crate) fn change_lifetime_anon_to_named(acc: &mut Assists, ctx: &AssistContext) -> Option<()> {
let lifetime_token = ctx.find_token_at_offset(SyntaxKind::LIFETIME)?;

View file

@ -268,6 +268,31 @@ pub mod std { pub mod collections { pub struct HashMap { } } }
)
}
#[test]
fn doctest_change_lifetime_anon_to_named() {
check_doc_test(
"change_lifetime_anon_to_named",
r#####"
impl Cursor<'_<|>> {
fn node(self) -> &SyntaxNode {
match self {
Cursor::Replace(node) | Cursor::Before(node) => node,
}
}
}
"#####,
r#####"
impl<'a> Cursor<'a> {
fn node(self) -> &SyntaxNode {
match self {
Cursor::Replace(node) | Cursor::Before(node) => node,
}
}
}
"#####,
)
}
#[test]
fn doctest_change_return_type_to_result() {
check_doc_test(

View file

@ -259,6 +259,30 @@ fn main() {
}
```
## `change_lifetime_anon_to_named`
Change an anonymous lifetime to a named lifetime.
```rust
// BEFORE
impl Cursor<'_┃> {
fn node(self) -> &SyntaxNode {
match self {
Cursor::Replace(node) | Cursor::Before(node) => node,
}
}
}
// AFTER
impl<'a> Cursor<'a> {
fn node(self) -> &SyntaxNode {
match self {
Cursor::Replace(node) | Cursor::Before(node) => node,
}
}
}
```
## `change_return_type_to_result`
Change the function's return type to Result.